# 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 453 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: eJzdWNty4zYS/RUUX9aukihbc0tUqWTt8WRWm9Rk1h5vHiauMkRCEmKK4ACgbUWlt/2S/bT9kj3d4EWk5JTnaat2HjwUgW705fTpBjdRqlxideG1yaNJ9GmpnVB5Whide4Hn0qlUeCMWygspnM4XmRKJyZ3CulWJsamYrcX0QuhcyFwYu5C5dpL0iVTNdQ55LPllKzYrdZZCk5hlJrmLo0FkCmVZZJrCCFmm2r8Nmy/5iEslU2wrpJUr5ZV10eTzpmf6da6/lIosMXO2ZPa7SjykNK0W0i/xnEMev5Jd5VNSbdWXUluF470t1SByyVKtZDTZRH5dkIjzFiZH2+0NbXYFaXC0Pj45of+g0kMlPcqiyHTC/ox+d2TcZkdfYclbr4N0x5Kd4xrrvfYZvejEA++7zp/1c6IeC1gJE5uFI+m6CUF2u5n4ixOuUImeV8YfU+KbpF9IL88WVqkVtMXi01JZJValQz4Vdl1/mP7j+h2f5q0k9AAARymEhKylYNy9dtA8gAWpvtdpKbNjOPM4zI0f6nxI+2fSweG5zJzazcvnSJPfjbLLStffpKPMOi+9ipCcbnx1up/DQTQ3diWRqwjP6lGuCg7x61cv35yOx2P1TfImeTGbvUjGybffnpzuRfsXTo4TK7km5wvpqEpmMrmjWnBmpcTZx2lTR048aL80pSdYAp9HH386HiAX8Jli75fSU32shbQUyd+i1Mq5/y1ClGIV400n92E/kgdxsUZZOm9sW2R1BHFWihRka0BBI0m0bGXuNHJ3Qfq7WoENwxqX8p6MuGwyNYPdeg4nKQ2iLNgZ7LjSi1z60qoBftzLTKeNkHDwNkspNguVU2mrNI62COMuhqYHU/M4nN8NVyZVGd52MLeXBkCwi0rC68NSJ8sG9EuAfqZULhb6XuV7JtQGP8OUeutBKxrHQT11EnZg/2c2weYnzWJoPxu+8nQ2Tl6kL9Wr+es4jvcMfWuKdW1gXYhkzJKLmZ8IVrSs8yQr0xZUrs41o0rlDo8ODqLOAS0PCxSZFqBBAsbqhc5l1gaB899W/TMiPm02H4x5u4z4Go4qmUntiqity4d0uCn8NN85dWZMpmT+VDxDH+idi3cTjlbrCZ9cGBQW0olywzEcuFj8SBR2cDvYGR0CzA62kCic3IgjYzl8qP0HdFJRUIpM2ThyzAEMLPdsSISAHAwfaxJzrVCnO32+ah9hNVnKfEGJnqPnDpHX4Vwm4I8p88+KWF5yPwHrUdYrRhHn50J7p7J5LP7JxMDq3ESUebBoVIAbCTArUFeLLjdqDFZ5uSLOryWI4cPDzTY8ssQzYNTw1IGm2eKaSZVKgNzNMnYHpFbiZ1UyvQZLhbCDOe1b8N+pps6mObKukfYBwnVHHmPjPYplruUsC+UUymeIvmUQsE/nFxPwSRYmKG7AjQciTBE/MBLQgYz9aNUcfThPQrerAiGtlWuafLxauUNDRTcOVdNXofYLVklcH45Ao0KWM/fsNh3EsB0zBXux35WrLc/G8Z7JHzDH1TGulP1phXelL3gMcrWDwHJdtCAu6oLMVe5n6fx1kVL3+gqlPZzAoUBI7WEZ9KKRBsXb8G/QyxG/6vP3nuJenzminFDXF9OrX8T4zavXJ8fYjtiqe8pnmQAnbl5mGaFjiaGaR+kNnfUyjLHdI2eSglJgAmhG7wOCp181/+5CBTgz9i0KlbJNzxc7x9/0Y9JHUSvdZgeUpBZsZYMeeLY9oP4A+FrAnR9wvMpT/9YhS8x2Vv/BHNUNzauvvBr8f4VmivMszQBOWVCe4GN6MQpEVlrt13ylOyv0T4oewfKb6FxhIrZnCDC/Ia/lgu5+0RldESkMOH9p6NKICyrfEGlvNOIr5KgqxWGomNGmd+3bUlNh2w7dJy/UylSmY19pqZcsvS/cZDRKsTaUhY71AjO1j7UZ3Y8jMrmr4wr2Euk/ocaF5QOabtq4XBE8Qlbr6LREH15Ud9wQ2PaWe1YhM5DwXvfDDYU6FeEXQalQGWZB7nw1v9529NyKcExz9aN+oR9BL9z/boON4lYcgUcVK6D7YMZhKGSicPVR8SLuqZ2ISvC7tSktRWQI476/5alnFwebaMa/fqwbxd9//bTvGxMduucdBuzqesbmBU2VzcT3HSNEE0GuSWZ7FoiaeqPURVseZeemLm4MRVx0mIgova4sCmP9X5uUtinR79tXXSy0m/cKqRESR//517+PqYVgKHhQqcbEzi1APYZRjeeJMF6EdDLydEJZMphElOXhrXTc/LL50BnsVpgvBBYBAr8e7I4nCciIXqPJ0y0vxVDvad7GhETfg3CYMzTfFQZjjEqWucnMAhSEFOdQQDmXIlcPIkMDyghQRELMVHIGTPg1KwEEDZJJ2xMDmtESA01IGLtn1aIMA5Hjz0yCW5jgImc7VzLHNZOuPGBXXE+Y9uoqAOgAwnF8shfzh4eHWPJybOxiVMm60c/Tt+8+XL0bksy2/QTT5oFqJzVJSV23ri6ikZCv8cn4ZfwiPiVZXAw8rNux5z0i17uc9BK+0zH+Vx/kKrR79ehHRYYhn3zh4G0qjv0cPtNhb5dl8WLS/7wGNlsiDiS02dCMcm2z7ZZefymVZbpH/KRl0AUqhsV4TpsB88kAHV1WTfNYPPkF8KA3NYXmxJ9MeGHQvCOG3ftCuKVrR0UPZGDYRTxT+B35vf6+3e1R798RVcmKx1oOv2MOrx5I+0Hb+nQeTKC/1HgOinxHQAWrft9sDytPCjQEGHZTpG7Qpf8Lf7K6Lg==
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: eJztW21z28YR/is3+GK5Q1IvtuyE0+lUtmxHrmOrkhxPE3niI3AkLwIBBAeIYjX81l/Sn9Zf0mf3Du+QRNnKl04zmYQC7nb39n33FtdeoIyf6iTTceSNvbO5NkJFQRLrKBP4nRsViCwWU5X5cyHDUAQyk0LOUqUWKsqMCNRUR1ikI5HNlfDjyOC5mOQ6DHQ0E5Mw9i9G3sCLE5VKwnMUAJPMA50dAtZBAeqdNhmWJTKVC5Wp1HjjX65b9L3PFxOVingqUuXHaWCINnOhEzGNU5HImY4YxUgciEjN8PtSCbzJo1TJQE5CJS5lmCsxxVGMmEj/giB82flCFGpC8Xuu0hX+iEAF/oynU6OIrlT9nutUgXbsNWrgGX+uFtIbX3vZKqGlYJmaqRRrwROZh5k33hl4Cx3pRb7A7/V6cF2ADfVCZ22UzbP+KK9oo4j6zpyqLE8jAZbSqdXoawnctVQ1MR9EIp78pvxMLHU2F0eHQHepjRVdP5saC+6mxGQpdMNbrz/TapOQ0hh6v7ezQ/+DFmVQCfopkyTUPkt1+zdD9F3X4CUpqVWm7e6grk/8RGdqYWqI7blAY6azkB40VLAjA3CiVHVS7UzqyLCem0T5euoII+FIYXAkKFiSp0lsFFZJ7JGRmJRWwbY0ElDOBlo2tAiqmhoZChkFfdvEZCX+tJDR6k8wtUBf6iAHc4EljfMZTLMJ8oRVZXQe4UhXwyjOhjoaEnsm0qhSLpWgfvEc2WSB9tdhjRMDlkgah6FKP6Zh4+/3pAHYFUNMpBGhXE7z8IU02uAvmPI8Dj5MPzJo6ZNF4gfMdaayjCyStuip8lc+fkMfmiLVQVdtePtCQj08/FZXcpGwLJ/tP32+u7e3p77zn/tPJpMn/p7/3dPv9zpi9dYDj7itrTptBn13tDPa6YA6gy44UKQFGTnQpm5AdMu5Ju9JBqywk+RKOAzRUTHyqPeoTXSwRcbCuuH2NaGQeO4E8/HkHcFhX15tFVsLuSK9i+GcSOv0VESxXaWjyzi8VMHjJjYW/p3oaNW34HO6NW47qmN+DtsJAMwymQXQtC4zp7gFNLMYkkKsggV+mqtI+AgKGcUo2YpqA+ZwKDNlMmGRFyZZBkQNmLTKuVIbVwaCzRfKLSNtrPxlgBDA2wOoRaBotz+X0UwJnRVhs4lfhOpShdZ6b3Jcx4W9bWbekbXSHNrx4Db2/PnObq+NRTdoRz/oQ8dJ5kXpTvo1iXjmljycLf9Ut+MCvtjS1o1PobPx0jp/tQBKYWGzhub9VtePfZ5liRlvb7snIz9ebCepvpT+anjDuY8VAEWkGmS6CCw1bQcpq6YPUuK4obSU/AxgB3EeBrCwjJ5JOo3VZaeNZB0i0xAZDvRbnmoTaD+7F19ffexQ/rYOaE3ZQ5ADyuoU6hynm4P+Qckwm/syVV2n6EBCLgwTWEiHThTlEFgC5uk4OJQr05sM9eJ78my/jYa8CiVeFijlXoBKBhwQZCCdqXiWygSSOVF0mm9n3psSIhBXIIHL4KBI/N7FNsp8E5ZTC0uEBTDAh2alwbFMsxUd+3QuGWiFZRLHoZLRTWiyFM6wW1ykAdJVwLQ2bhzU9dpJ7CAD7ZM8U3VByTSVZBBlKgfN/TDl4qDtG3vkJUuQRf7WDM+GLAZk+1m4glFJTsZ8Ck8+ItLovv61TsHD5zL7PX62eUok6/d3vO+7tDc9bQl+wHUWcuBMRr4S54zo3KMS69yDCp2z228A2pSI1zkCalRDWmW53TNXf3VIZONQkdHINHW22lxlnVBbplFBKhOYBipokZrF6Wrzg8IboYzpOdVLB6ofkfHj5B4yJZffNXSCIQq1ZVm2EXE52LarphrXPNGtdnq7dVK5b4vaGrTbrK1JBHK3AAlDf858QwR5cvhp98ePn35evbg43n/35ml69o+TH8ZPxi/fjb/bGRc1cUcswEQuH6UZ9zo0q521M1uIPgARe+OXdDb2Skp8mIoTNQODbMNk/Kw3XTll5EwJ//O5bXoP4gHPORwU1eHGqX6xYd1bT94JpmXhNWj18nJjrne1j6GICYEpXUiZfg/LNtY2UvGZDH+NJ6Ge2Xx+21Yw4Bd+wjHgLeUSpMd4kORY6f+aSXNhN0NdQJAq1xBdEfWDfvEcEiqAW0iKAluy4TSRcIVeIrGbO0hIF+ql99dz6keGQjxC6QPOROSnt9lv/GriPEUYcH/l1AD51aj0UvuqOiZtsOHdrffcX831rL2JltDZbyH3zBZT0MGozJGVODw+OoCnSeKUtXumIupFwgXKKRhGzRMs8BwFp/liIdPVRoU0oft4Ego4J8QqqiVr6AxVMxarQfptwQqV+Y3eELJu2CJomaxQPK5EIUNlcyXyd+Rp9CySWZ4yb66G04vhIg5USG6gfNNxEMUb7k/lkCNScaLR5mB42CyUt8oNRrjKHKVBo7sLh0z7FjiZhgRESZZ5fGu1Widyw36UXIUxxzBT22uZZR2X1czWw+NyW8/TH6SZt94QYSp4sWJaF2A7NOvhM7f9vsztAzOpZHUiDfUWuCcNVTAxHOnB8VHZjjfcjY3zDFoidCC2jv/2eICQBGZavYNKQUZQIghcIh8LUmj3uTcQeqRGeFKpQ+a8PJWCK5UJKiYqIRdisa2MCFFBXSEWGX6fSkqIRuzXHas35sz1aDRa95oQwirCqwNYkmdYNgN2xigofDZYg5O8Pf3wHsVeiphcdFmglDCiMDDiukfwYwHUA3GDSvS8tbrV8+KAojTccs+rQpV6Xr1dGtSvgUoHotQyt8we8pMVrVWJEzWFB0CC7ZZYazoDjxsPmsvWI3HqONJgE5XeI3FkQ1xpSk0vOFEQGMl7hbIPukS871eJLdKJOUNn9cuoj0YrWiQVzYZac2+axgvbV3FiRk7CbTSLhj3xUqaBGXX83WbqpVZv55M3vv6g377++dXJ2d9P334PxtzuFgticKa5bftZ4EVSUHGsOpFLn6zLVpAcQkhXeago6tUB17Fq+7HNK/hgb39/9/vyGHs7e93k8EAsVRgOL6J4iXyPAVa+wgZGmx8Ut3wj8RN0J7B9TDMWZy8OR4LvAxd6NueWkbpKIH4cm6+FTJ5QZMOf9cM4qIb2QhUK5yYF34PByI1i3la73QYRKV8Zgwg5ajPo+GEczREFVvgZOLRK9U1lM60WWmDbPU6hWdaVIVrf2NL5IevDFadt3FaOKvguNdBFxWXYOm84KcepjU8rdyd7/pPgqdqfPuvT995z++kqycrmEml/cW57QUoXTqr0wBxBqpdY2Sef1mEKV/kN2dxBU7ekg1i4JYLi7t6QTFGeYkUCghdypgY160XW1aavDP0b0xfoYHyhVuN/PvvxYtrH6hfKlzlHTkRoKhrhJdJHFDktQDYQWES748qex3plCUOwbVl2wS4Y1vbbMM/b2JBwCtAMF99M0WRLxCUrBrZrzNGycGplYUhJR0U5dwjCOL4g7c2T0qOtikTXFiICPKn7yzLF7CEqiqPhJoT5Dbqwj5bAfVRdIbCV2kXIrBPXUXFX5QOBsliHQgYB8lKDZHboeAk9iWSCM2eWrRNA4+v0pqd/IA4715fZ/Gam0iSlqYpOewsHqfOR+mtWEIQIx5Og8AJhtgyg0DBSqqNDeBdDLqvjMa1qH9yjQr6t23Zy8PpMvD569e5wLE5d7LO34KkKbQ9hrhOcNVsqlw7Uq40aY6PAnd2iqlVoRRyGxH14K+NiD/4FDnUpwThSxpeuLrf321h1HIMD5VwH4tZ57SjnHmpTJMKK6utMnXsdRlVB+RucVMj+lWdNnC51w3szHyQHz9xoC83pz4xgIYH7dFoPUG4oY+vk9cvn+7v7fPFUFS0bHwD5wtPhzu5wd/9sd2f8ZGe8s/NzNysv4BYW4Cjz8xTBjlpFNWPVJnqUscmXd2dOnCYWOntkKw2CptIhKqt4WqR4N2W+39i2PYIKUCfNWDtvB+olwm+opnAAoYwuimjSkwrwblptaSWqqxzgPs1YOx1za5Pd9hIFl/X9ZLsykEZIfiq1vZRN0YYvkJ17tVZTjYIqs/5cHqeP719R5j571lPmHgizWiDJS/kSKyyaaFznlulVYTi1DKvF+5H4pLi0rTTwt9xkll9h4Wds2hVzSl75nS1pGxmPiUPlMjgRyxSxZf2Qa8jIctzJeXnnc+z41YCCe21SwN0SI794PLI3WW7IZWMN7nqUznSQBckeI1LLvlEfU84M0VCDVdX6kM1DUWOxFbGNPCtlk0sep3B80rZTEaRyGQ0o09VQWm4hsKRd36FM99mv8zignOhQZzb/9+NFAlUB6eQg3M383Y32Rmfs9tmuT0fHYxtknBNr+gzunVdCKLhcBHXqg0B306qwBSBRUS0SUqI4Nw1lYjsnm2+QZlvs1RDUnV1HJv2ltQPxrtiHJIcbnxZNA8NItJcZtqVimmUhI7oA1q5SEMs4vZiG8dKwyrUnB4y1SBqDQFyGWS+gT6DTWFFaXe3nn51pKbwSd6g8K2xSJNsExsaPlDic2s7wLXdMm10B5zYLsdCaszlEb3f85r6Xvm7sACIsLtA7DcT7XcjeGieC289k7z/vN1vRc/1CQ73GDVQUmNtownsPH9yIqAB1Eyo3HnOIvGkSyzS4oTl/T6wOKljqwIo8DftJsNdrEGl0kOjT+v3Z3VedZ/Wyxs2QfiBIx0etWcEg9nM2FwtgUtRZWPmoGsxGTcAujmoDakMUg9W2c0b6ccoXLd9sOe5+53/DZHoO839b+cNshRKhhurxhUExn3/bRPZxtapz6W9DHlbUNaM+1t64uHcBkgbkXWugftRdojDOZHjUGli4Cd4ZLa6N47MpCXkpdejmmEvYe/sFcKL1a4AT0fSBAtd9kSi+F6jm0zhjoId3w37fIrn4aqDBjR0AnEtz7NKW3oTxpiJLT23/6hG1r8rEp42CvYHF8l5dZV+PIcLuDnSaOFvX1c4plh0u6xmLqD5h2SrZfHT6Qew933+28xgc5ytYk/uUp07zMCT3OedmAXGHwD61Xys0oU8k5ZJJzgWx/ZSlZ+PuvT5zqHtQJJ1x+hL+n05Pv+uDFZ+7V7BNE6p29+lNyU2cbN0DvseNVK7jRc/B1+se/n+MXHvonyrosGb/nl+A/G+xpujVc2oHM2U0LR7ZoJWnPN2GQI6E5G+Kfn6m2a0XCol9egAG8xM6tZxRxPcOqMYiNizchZM3U/aLK1rrbXMNtk2xclgZB8dqIqXvc6xDtYgdpZ6bgS6HmwO8G8pEj/QMtVI20vH25Z7X/djoNCN/P7sJjLGveyB9rtjAk1BWiAUzqsTHPnCfLVk+euV3SwdOEYt402pdIEGjniypK/XEffdx2Vn9JoTi35cGnC/CohELalBMuBac6qvi4uyLpVF8EVvImGyDGPWktk2MRPrq8UCo0WzUAjsWbuOfV0hliCNDEPeXL5z11cV+7U34r9dFhH/76ax7NvZrrrXsZg+YPAvJ0Uy9sQYRouQgmyB7b97gleZFovPWPOo9jQtbdvdA3JknG7HXf38tRVqJRL+pHjV1oVrcsZtyk9j6z7/+/dhepJwuVaDN3KZ/6spdurTbrmUVZWd4VDoSRxlVxpTShdOhoVsahYrXXYxkq6KXy98T+uV4ILfqAz2jaS2xlCEqWnsFGNO9ahKj0lb+PIrDeKapr68iALCdKGrq8DcfHKTJB3BSb/shDAQqGC/s1ypcLWsewGWBuYvKWe568XybLjhiFX2VkC5iowhno5Qbh43sTFhhBVA6KOEeDxk2eb5cLkeSX4+Q5G27vWb73dHLV+9PXw1pz7pK3io5kO0U5UxhXeV3GtyDHj0Z7dqve0wG6mr0vL7pa9O2FtfixB/67arT7AyJx3YSooCrffNh3ecv9otWz9ZfdQcKPzXHCWnJ9TVlGsjH12t6bL+hZLeK3BlCCvrb2fVT/rFfwPae84L8afUhLG/3+AOf+xB+389ZbyGlSIa/kpI7Pm+9BXFjXYX9M/2RattnpShchBkSrd1J3jap09xJatb1wPzmFTls6bx5FckuOJK5H7UiXkarGux2ULMk0H9rw93NLX8mc0Vs+Uu53L65cUMZBuxq4hIVff8FoiuyFg==
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: eJzlWdtyG7cZfhXM3lSaEUmJPjWaTFrJshM2rqzGdnrhaCJwFyQRLRcbACuJ1eiuT9JH65P0+3/smStF1rQznVYX9hIL/OfD92Nvo0S52Orca5NFh9HHlXZCZUludOYFngunEuGNWCgfr4RMUxGbzCm8tCo2NnHiWvuVyOVSZ5KIiIWxQmeJvtJJIVOHZyEzYexSZtqFLYla6Ax08cqvVE1xXug00dlSzFMTX46jvcjkyvKRWQLhZJFofyK9PFpapdY48kOQ4Z12HrtzaeVaeWVddPj5tqfZabGeKyvMohYcWrlLnbPAjfxjcSQytcTzlYLUosiskomcp0pcybRQYgEjODGX8SVRuNi/IEE1sfi1UHaDHxmkwE+zWDhFcln1a6Gtggo469Re5OKVWsvo8Dbym5y2wthqqSz2wjSySH10uL8XrXWm18Uaz3d3e7cV2VSvte+z7Or6Z3lDB0U2pLNVvrCZgGVJazV+qoAHQaou50+ZhkhidkJMye3zX1S8JW2libxeFOmxdNpFAzydtwiGLeXe8Sk4AMeIC0WQrAJCjOpomogUbkx/NvNUL0PcTeiltzKmt1fa4y0pZpWjhbzAzvhnL91lOKy9Xkuv6j0QRWXkj89RyQQrfSZYqpjgscuEYrRhEg5vMTkfMCvsSUSlzlwrt2DmPZEgH1r6k+VtL0exeI8HdPKA4QfkcHCmsZXVH3Ru2Pog+XOKPJeTrI7eT/f36T/SlGyLR5nnsBbbdfKLIxFuW/RyS/XB63C61LksCbSivVrzAzL2/YJrQilCLbnXPqWF1+3DWyF31DeouskhOcSuX+xI1y1rCM5uPfudEy5XsV6UCu1SMkrhsAG1pVPWxuLjCsEg1gUCc47wFp9OZ3/59Ia5IbSoNiOcd3q+t+pKO1Dea8XILpS5GWXGj3Q2ov3IG1XneZP4n0MsyKayBlrfSbciJ3rEaASHdW2OMwP5ioKKkMYKJcyNXOds4pcvnr86mE6n6vfxq/jZfP4snsZffbV/sGXt9+wcJ9ZyQ8rn0lEP4oI73whn1kocnc3qLhU6kCk81RuE/87Z97tICwWdyfZ+JT1F60ZIS5b8KUqsXPifIlhprMZY6fg+7IfzcFxslBcOUdy0qsqC4JXABekGoYDmw6+tzJyG706IfpcqYsMwxZW8IiF+qD01h9x6ASXJDaLIQzuV4oNeoh8VVu3hBxqPTupDwkHbNCHbLFVGDVIl4+gOZmzH0GzQNTejxeVobRKVYrUTc1tuQAh2o5Li9XqlAQOqoF8h6OdKZWKJZpltiVAJ/AhRqq2DUtSKl3WnF/YPyQSZ7xWLQ/vR4SsP5tP4WfJcvVi8HI/HW4K+NvmmErBKRBJmxcnMTxRW9FpncVokTVC5ytccVSpzeHRQkMo9rA4JFIkWQoMLr9UEV9LGCOz/JusfYfFZvXnQ5s1r2NewVUlMAoNU2rr1kJib3M+yFte5MamS2X329LZQW3yxdsjWavU44pwbJBbciXQDGzbcWLylEja4HdUZXQOVHdVCInEyI3bQtch8yP1r4FGRk4tMUSuyywYMVe7RIREMMmg+piQWWiFPWyi6bB/hbbyS2ZIcvUDnH8GvowVAw1jMuP6sqcpL7ieoeuT1sqKI42OhvVPpYix+5MLA5NwhoGqQaJKjNlLArFG6muhyk1rgCsZUJ6jCh4fzu/DIJx4RRnWdGmiaTVxzUaUUIHUxQ5A6jKZrBNdrsJQIrZjTvgn+S1Xn2SyD1zXcvgdzXZLG2HiFZFloBuxEJaTPCH3LwGAfj08OUU/SgAe5AdcaiIAs/sCRwOjlzKoF+nAWh25XGkJaKwno1PCiDyp6mCk0fRVyP2eSVOtLLJUoeDl1j27TNa4CpgiAc6srl1seHcdbIp8CwlU2Lok9mOHd0ycMg1ylIKH0MmkJmkJHrlXunXT+U55Q9/oCor04odmNC1LDLAVdNNJA+I7/9rZ91LUYMDigN+wxAFN73WPI4V1iCEBuZb85yfwYNpKluy2NmOaFRdkbrEbDzqoO4Gx7sHp6FPwfDFr4o4LXSWyyfX0bMOTtamY4a3b1QyAukOKZx462A9tDdAc6hN08jpcze9szByShgXqzXsG5j95H2twa/rlQCXmFOkNlsU17+qIiTrI+hTgJTdch1OHg+ep2oubwjOKRF3+b9mlP5OqOomONfRBEazgrO/gjagdhmZhaJCFtT5MVZrEWBuiz4KobuJyqG/90DhlOb1En5MNFqRdYvNTHlN2rNqp23UrhxE5t+tmH92L66sXL/V14wVHFdUWM1uWQxSk1rJWSCV+O3RKr52Ha7nKcS6rTeUFil5dpAwcPvmhMb3cvtD5jXwM7kEXo+aTF/rxvkn5aNaeHYqm2MDS7GyA/UAmb6nc8oHjoHVs3XLLAuGn13xg2dU3z4gtvMP63TDOjykpjiVMWTVAwm56NArYqrPYbvpA5yvX3ih7PqUsfKwzp9ggG5hXSWi7pNjc6ortfMgP4rwzdBi9VuPOlvdGE74YnZbcYlQlDsJZFGboQPlFrU0qKfYUlNLvyPneHk0mCdyOZ67FeYqr3Y20mV9No+z7sg6cesLyPjAuvByidN2b4QNEQnFgZo4GaYaG8YQt2bK7YjspArHpQD3+fzRgrU7jCJmUQhmk03GSXPf2iQ+dCBDb15RMhVn2DasII/CLIKC7EDpCcYgJ0I5WyGXIZq909ocbLcY/soSgPfr0xhSWLjCDcNxc8d7XdfhvN+dfbCqT86a8ft3Xjugb8fokRv7wgYvECpVJmQpwdIURtQU5Bruh8IKrTi1xHN5+w+MJUuUwQg3IMMxm51xV5bqz/Y+3S1oXqt81SNxaazVt5Ux8SO//8+z92CcRiLLlWiXarUO/VTRgWeaIJA05wJ0eejslLBrOQsjw+Fo7hd7oYOYPdChOOwEsEgd/stQekGLWHltHw6J4p0UuCUeIaM5ryzMwZmjBzg0FKxavMpGaJigMXZyBAPqcudw0Qh+mcGzfVAP5sM0dM+A0TQQgaOJO2xwZVRUuMVMFhrJ5VyyKMZOFzkeCOJTinWc61zDLoRkAOymYBFldZgKBDEE7H+1s2v76+Hkt+PTZ2OSnPusm72es3px/ejOjMXQPoGj9Q7iQmLqjFVtlVw/pouj99Pn42PmCoaJyHdC153t73pawfxa0+8d/23a1MBg/8MslTqfluj217W1bcz+FrXADhnZqL0raCUWjL7S2Bk082vbuj5fCFgCsxJIJfmw9O9xrmP/vZblDPSyrBzdc7Pk7zEZf/Rwv+pd/gHhClwtRPlOTeb3IPsex8mnsi43/HV6sHZOQPFk8U7Z4PWQ9wq+9dGo7n9MNyJQ0ApurQFOLhFDWqvO27LTx418Y0376hXifLRtiAgEsGAeVD6zuWzDYt2n08EESgf1s3IN0jX1OlQ1v+pt4e3tx7oO6gpQ9IAaC6fwH6kUPu
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: eJztW+ty20aWfpUu/ok0JVIXW3bCmppa2bIdeZxYq0tcm8gVN4Em2REIIGhAFEfFf/sk+2j7JPudcxo3EpKpsXZ/TG0qlUBA9+nT5/KdSzfveqFxQWbT3CZxb9i7mFqnTBymiY1zhefCmVDliRqbPJgqrZyNJ5FRoc610pPMmJnBwHGSKV2ENldpkaWJM25HmcFkoEYLpWNlbnOTxTpS+dRmoUp1li8GvZ1ekppM08onIdZmAmdGh2cmSLIQ3zFQzwzmut7wt7sVVi9j+2dh1MmxSsa0SDL6wwQ5Zln6mup8iucY8/EXsXtUcntCpDPzZ2Ezg3XzrDA7PRdMzUz3hne9fJHSFJdn2GpvufxMg12axNgVfT/Y26P/BUmcgxg96jSNbMAb2f3DEXN3DXppRtvMrcxucdJYruI+t3lEL45bA3dWNn8UN6RPrGgbO4jXKJeawI49OyyaUmdeNRilMQcSGxma6kCCdTxQ6ki1lmUDiO0NFADl6TjsmkY6/stMx4u/KBuH9saGhY6IlywpJmQyLZKi28FVjC3d9uMk79u4T0IZaYdtjzHVNLXzW8+zTeYgT8cNSeywHrIkikx2mUWtv38m3WNWAuUs8BDp+biIXmlnHf6CXU2T8OP4kknrIMc28QBLnpgc7ET0V2THJlgEeIYVtBVpw3Vj4ekzDb328Gxu9SxlXb44fP5y/+DgwHwfvAyejUbPgoPg++c/HKyptbfc6ZG0rRjRZtT3B3uDvTVSF7AFT4qsICfHbtsGVDefWvbqzAQGM0mvtIYjPmpBnnRutb2cuCEZYD2vTYXU81Uyl2cfiA7DSz1Vbc30guwumdmcrM6OVZzIKBvfJNGNCbfbq7Hyv7ocjfqW9bxtDVex6ZTfw3dCEBMhswLa3uWmOopomUkCTcUmhAd+mppYBZmBiuIJNNMG2h2WcKRz4wC1soh3yQqobRTxqNCMdRHl6kZHADjF7gvj1rF1on8dzmzM00OYRWhodjDV8cQoADk+MZU20EfmxkTivfcB12npb5u5dyxeWsA6ntzHXr7c2+/0sfge6+gmfewlybKo4KTbkkhmfsjT+fIvTT8u6astKzA+hs0mcwF/M8OSSmizhRbdXte9+jTPUzfc3fVvBkEy200ze6ODRf+efZ8aEIrJNMh1EVga1g5WFm0MMuq0ZbSw83AHfpAUUQgPy+mdpt2ILXtrJO9QuYXKsKE/isy60Ab5o+T65nKN8/dNQktKG8ICVBbnMOck25z0j0ZH+TTQmVkHRU8SemGaWIVs6MxQ5oAhEJ5NwmO9cI3lkHiZCcDznvWevThcXYZQBaL0RFXKVMmBQ6KMRScmmWQ6hWbODO3m24X3rqKIhWuSWMtho3piPiQSZb5plXOhpaKSGOhzCnlKGSRt+3yqmWi9yihJIqPj+5aRbG8t6S2zUvFx56kul15jRzl4HxW5aSpKZ5kmh7C5mfF7WO7HMWeqq9jYoS9dkSzzt3Z4duQxYDvIowWcSnMyFlB4ChCRBo/F1yYHT5/LHHbgbHuXyNMfD7w/r/PeRtqK/A6XIMiBcx0HRl3xQlc9BDw8w4SuGPZbhDZl4m2BgBo3Fq2z3PU913+tscjOYWJnkWnafLG5yXqlrrhGTalKYFpLwYrMJMkWm28UaITipWNXrz2p7oVckKSP0ClB/rqjEw1Vmi3rcnUhuOK6X7XNuIFED/rpw975wSK3wk5b1B7ytjYTyN1CJAzdOfM9EeTZ8af9ny4//bp4dX16+OHd8+ziP85+HD4bvv4w/H5v6BO5dbVgJYJ8lGYYYmPLZid+JuXnEzBxMHxNe2NUMurjWJ2ZCQQkZfvwRWe6cs6LMyf8z+dV13sSBLzicFBWhxun+uWEZWc9+VUyKx7eoNYsLzeW+rr1MRU1IjIVhFTpd7+svNUuUvGJjn5PRpGdSD6/KxUM5IVHAAO+Ui5BdowXaYGRwe+5dtcyGeYChkw1hviKixnFDL8IFcAri5QFtmbHaS/CFXq1iExeW4RsoVl6//OS+ompkIxQ+kAyMeH0LuPG7y4pMoQB/1dBDZDfnclubGDqbdIECe9+fM//1R7P1ptaDZv9FnYvpJiCDcZVjmzU8enJEZAmTTK27omJqSMGCNRjCIyaJxjQ8xycF7OZzhYbFdK03OVZpABOiFVUSzaWc1TNyKoO6beQVSYPWr0hZN3wRfDCTbyFKnVoJFcivCOksZNY50XGsrntj6/7syQ0EcFA9WUNIMov3J8qoEek4sSj5GB42S6Ut6oJTvnKHKWBjU1YlqkBAJnmzbAzCw2oii23/WC12mRyw36UXkQJxzDXmCvCEuASy1x5eVpN63j7o3bTlS/EmAlfLZjXGcQOy3r6zO2wK3P7yEKqRJ1qR72FkQ6uyRRcAiA9Oj2p2sROzS02XOTUhbWh2jr9+/YOQhKEKXYHk4KOYERQuEY+Fmaw7qvejrIDM8Cb2hxyj/JUCi5MrqiYqJVcqkVaGTGigrlFLHL8PdOUEA0Y172oN5bM3WAwWHa6EMIqwqsnWLHnWDc7DMYoKAJ2WIedvD//+DOKvQwxueyywCjhRFHo1F2H4ocKS++oe0yi46vYVseHI4rSgOWOT6UpdXx6P3eoX0OT7ajKyvww2eQnUa2YxJkZAwGQYPsh4k0XkHHrRXvYcqDOvURaYqLSe6BOJMRVrtRGwZGBwkjfC5R9sCWSfbdJbJFNTJk6m19OfTQascJS2WxoNPfGWTKTvopXM3ISbqPJMozEc52FbrCGd5uZl1m8n47eBfajff/21zdnF/9+/v4HCOZhWCyZwZ6m0vYT4mVSUEus3pFPnwSyDTSHELJuPFQUddqA71it4tjmFXx4cHi4/0O1jYO9g/Xk8EjNTRT1r+NkjnyPCdZYIYFR8oPy9GmgfoHthNLHdEN18ep4oPicamYnU24ZmdsU6se2CYgQz1KKbPizuRlP1dFcmEIJbhpUYuQoEdyWZVvP9hNUbALjHCLkYFVAp08DNCexHI8B0GrTd7XPrLTQQmn3eINmXdeOKNi4YvN9todbTtu4rRzX9H1qYMuKy7F33rNTjlMb71bvjw6CZ+Fzczh+0WXvnfsOskWaV80lsv5y32wAfOBkKgTmCFJ/xMgu/axspoTKb8jmjtq2pT3FEpaIij97QzJFeYqoBAzP9MTsNLwXWdcqf1Xo35i/0IbDa7MY/uPFT9fjLlG/MoEuOHIiQlPRCJTIvqPIKQTZQeARqx1XRh5BZQ1HkLYsQ7APho35EuZ5GjsSdgGeAfHtFE2vqLgSxY50jTlalqBWFYaUdNScc4cgSpJrst4irRBtUSa6UogoyKSJl1WK2cFUnMT9TRgLWnxhHg0BfNRdIYiV2kXIrFPfUUFtMhtRjEVZbCOlwxB5qUMy2/eyhJ3EOsWecxHrCNQcibqN9E8kYQ99ueQ3E5OlGZ32r7W3sJGmHKm/JoqghbA9DQ6vEWarAAoLI6M6OQa6OIKsNcQU0z56RIX8ULft7OjthXp78ubD8VCd+9gnp+CZiaSHMLUp9prPjU8HmtVGQ7Bx6PcuSzUqtDIOQ+MB0Mr52IN/sYa50f72w2tfl8v5NkadJpDAKDJV3LpqbOWqh9oUibCh+jo3V701QdVB+RtAKmJ8pZPt0pbWw3s7HySAZ2msKs3bz4RoIYH7dN4MUAJuauvs7euXh/uHfPBUFy0bbwD5wvP+3n5///Bif2/4bG+4t/frelZe0i09wHMWFBmCHbWKGs5qXfxdzi5fnZ15dbpE2fw7qTSImsn6qKyScZni3Zf5fmPb9gQmQJ00J36+GqjnCL+RGQMAIh1fl9GkIxXg2TRaeCWu6xzgMc3YG+ukrXN/k116iYrL+m62fRlIV0h+qay90k3Zhi8Xu+o1Wk0NDurM+nO1nS65/xNl7osXHWXukXKLGZK8jA+xorKJxnVulV6VjtPIsFZkP1CfDJe2tQX+Ubhc5BWVOCNpV8IpeY07W1oaGdskoWoYQESEorYEh3xDhrI+/0FQ3mNOxpizQ8G9cVPAnxIjv9geyEmWv+SysQWvI8ra7SAhyYgRm3nXVR9X3RmiSw1iqs1LNk/FjaxWxjZCVsom53ydwsvJSqcizPQ83qFM18JouYXAmvZ9hyrdr2+16ZGNbC75f5DMUpgKWCeA8CfzX2+0tzpjD9/t+nRyOpQg40GsjRncO6+VUEq5DOrUB4HtZnVhC0Kq5lqlZERJ4VrGxH5OPt9iTVrs9SWor3YdmfXX4gfqQzkPSQ43PmWZ1goDtTrMsS+Vt1lmOqYDYOsrBTVPsutxlMwdm9zqzQEnHknXIBCX4dYz2BP4dKJKsdVu+cmdlhKVuEPVE2WTIUkTGBMvKXE4l87wA2dMmx0BF5KFCLX23Rzid/36zWMPff21A6iwPEBfayA+7kD2wTgRPrwnOf983N2KjuMXZKywESFUrry6TPToywf3LlSSum8pfz3mGHnTKNFZeE9z/pGreqoQqSeriizqZkGO16DS+Ci1583zs68fdV40yxp/h/QjUTo9WbkrGCZBwe4iBEZlnYWR39UXhlETMMRRbUBtiPJ6r3TOyD7O+aDlmz3Hn+/8a7hMx2b+31f+13yFM6G2ick1n44D6voAisyGzhzUyflHdfDy8MXeNt24yqy5oXhTBJQzjIsoIlOecuFGtkKEn8t98Tb9kaa4nhZcnMgd946J+4+6aN60ZiQASfYavkgypOfmIffn9eOwtoXXs7uupVU6wc6WHeQ7VFqr8VXHxpfLDg1cxr5U/4cJ10Rz+Mg7+P9aoin7phxmUU/wMisyEgApMr5pBFBFcPi7ocfPdI/mlUGSlR1BwPyGdq0nhL69I8p3SQwz3/zvIVMnKdDvKYa9Xc6Hdwm3+pV77N6t/L5iyUBKvHX9cOPYzBLPes9fUK1unob41tepHdgJEtl8YJPdm4Mesbx6M1BPykSjg4yTzx2UPtdy4WsqotVSOnVUkhf+xyQi2F71c5Ijb5nllYiVuhLRkxpmZL/UsBSr5HOHuk1N4PSlReeLkmXUjKrHESfqY3tbnmp8ER7VF7WFcCbdOyT7VirMVAdm2//mpk12qPzEvy4QZ0gifTD3ty8ckpt2cNcb8V9vS/h9/+lifW8MdL7v5w+GmT2h5HmmxkWLCVVJkH2Sqz2eUJ/Mk+p6S76HO05K5/ZNem6bktPI2cy/VSqtVWLf1a/atlAPXnOkapLa+u///K9t6XKfz01o3VRis7n1HfHVnliV4soFC5MN1ElOZQvF22jcd9RCNyhHfNc6X5SNNqp6qRj2d7e4jxraCV2lUXMdodyQ85mEDr3SBGWQCaZxEiUTyz+rikFA2gRUcfOFfDIoLpE445JilYnABJOZ/JSASxnLtyNZYf4UaVL4RikfdSoOYWXRG9EpWRxjb5QPYbOxXNgpvQBGByM84BtgbZnP5/OB5s8DROBdP9ftfjh5/ebn8zd9mrOsL2HUeiDfKXPN0ruqS/TcIBw8G+zLTy9cDu4a/Lwz+Xryt3Lls4oY/8e/dPNGnuP7bhoh0W7czRdo/U1+/9aTPLnf3MNw9edrALEptk+T7u4oNUEmtVzS6z8LkzHKQ2w6s9JhIQRGDoTnsLst2ZTL1pmPldvq3l/Yde6mRM6YYJNxTrK2awLWtV/gcdXiUYEYlFEEL2nemL8W1pfN0PTuDSGU9vBVQ/c1Q7d/aJQUbd5WUVxYoP82rpq2p/yV7BNg+rdquHy5d0KFezKaJEUp6P8A+0wCwQ==
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: eJztXetyGzeyfhUU/1hKkdTFlu2otrZWluyYjm3pSHJcG8sVgzMgiWg4MzuYEc2o9G+f5DzaeZLTF2DupElbPsnZYirloshBA+gbuhtfk7cdXxkv0XGqo7Bz2LmcaCNU6MeRDlPhJUqmyggpfJlKIceJUlMFH4yiRMhQRMlYhtpIHNwXV+EgFTIwkUhUmiWhEelEiQAppPDWjTbwmIhG9DaT9muE+1dhp9uJYpUQzYEPS/KicKTHx/T8kXsQnoplIqcqVYnpHH742O0k6l8ZzPQs8uedw1scluKD8FLGcaA9orjzu8F93naMN1FTia/iBOdLtTL4F66nmAUHB8HpCGa47aTzWMF6ouHvysMFpDoN8I2TypBujaNHYYlvuCipLWdMrDw9sgtDvkhhdDgOlIizJI6MgqckjAFGDxUONUACWJZGfSGORGVaAWLLQn0D3JABiMZvGyaGc/HDVIbzH4QOfX2j/QzEBbMkUTaewPQVkufKixKfJfK5F0ZpT4c9ZM9QGtj2CIYq5rpOFAjqQ8cuG2XDr05KnOiSRJIoCFTyLgkqf78FQeKoCMQ0hxeBnI2y4Jk02sBfIORJ5J+O3hFp6aWwTXgBOjhWKSwnwL8CPVLe3IPXoApVkVqyKNyKZM7ofWCbrxIxm2hvAqwAPlYZayagAcjJcQTcDZUPzH8/USFrMMirYR3dst7z5E4amWFBjDTQxKd8NZJZkIobGWSqK0hyZasS0p/qkIb7oC2+wtHeRIZjJTRIPWQqVesM1I0KWHCLdPbMsXo1yYYsoAzk1mCv9vFfO5FJE2AJS2cqwYA68Fp9ltOYpn188OjJ3v7+vnrqPfEeDocPvX3vyZPdvYbVdO66POnKpE8sJ4kXuSZVqaKeOQdkH4F50Gg0e4XVptrr7/Z3G8R/YTJV+mJLswWPQNGjGdu9msKUgmlv4wqQryvPPknT2Bzu7Nh3+l403YkTfSO9eW/Bvs8UEApRNd6dvxbgU0raDkuZi5vq2s8qSgt67nfBDqIs8AVoC74ncTesy1Yb0TpEqkFksKHfs0QbX3vpWnx9/q6x8ldlQkAY/FYGVOYXoM5Rsjrpl0oG6cSTiWpMMbAkQS5EE2ZBHTpXeHzAI8A8Hfkncm5K08HpqMYqWTTfw8cH9WnQq+DByERFTFTRgH2kDJOOVTROZAySOVe4m29n3k85RZi4IAlzGdioHKvXER8+3zTLBdMSgSMG9EGzEv9MJukct30xkUS0mGUYRYGS4aJp0gScYTMySXwRI022cWOp3t1ZiR2lsPZhlqqyoGSSSDQInaqpWX6et8hL5iTd0V09tQ1aDCzbS4M5GJWkc9jDM82DI7e/rn8tr+De/ezTgxY/W92lGJys73jfNtde9bQ5+S7FjRD+pDL0lLiiia46cODBa1ChK3L7FUKrLuJFBgdqWJq0CHCaey7+aiyRjEOFRkOQodP56iprhVozjYISzuRXmI1TgRapcZTMV98oeCOIYFt2dWxJtU9kvCheQ6bo8puGjjSEU1uSZX0iMMWmXVXVuOSJltrpcut8rSG2gp1WqC2ztuoiIHbzIWAYrGFSLx+evN978+79r/Nn12cHr396lFz+8/zl4cPD49eHT3cPbSDXFAvMhC4fonJ4RIea1I7tjHOQe1jE/uEx7o28khKnI3GuxsAgTqIOH7eGKxc0Oa2E/vtYN7178YBXdBy4xKBln8Xe3sjkWlFADRHNFJIZO8FC3+Ko3rXmG0vnOuYF4mQQkls9RoWOrXlpDNSnbkVfciGllZRTl5XFapO0ppYTMTFEarmrysP8nkvuxA6E/GMZ/BYNAz3mvGGHxJWAXOAlOCD4FGMWtBd4I87gSe+3VJprHgxqCetS+TO4vDCb4tlULK4+icvhJBlodRJKAvNJeHBjEtS5cna3MsNQXr+ZKEu85tHzhggiu0C0wKQQj4YdURri/sow3f4N5H+jiY7dMQ7o1qdoPk8GE2sJZrLGyvd39x/1dvd6eweXu7uH9P+vjS1cck4HWh7moboSJ2eDI3B4cZSQkY1ViGUS0FM5An5i+g4PdOyqLrIpqO/8XXtm0Zzu3XkgwEfCkYlGUZrOYFLFsxrIApisUKlXqU5A8A8uAdYynEMOOxdOxIpDNnS76PD0OJRplhC/PvdG171p5KsAvVH+ScNPuU+oQpKBbCEjwDVyKAhvVvP1rXyAAQOeUw1kAm5L+S5b9uBcwHFT2JkGqYh8WWZ7adJcXuSKFRE5DyI6Sk1pLDOL3Rtra+3Ns3xYy7svpZnUPsGFKf/ZnNY6BbaDtt1/AHnQFkCeEpNyVsfSoOccSu8aVcFE4KqPzgZ5SdGImYYNZymWD7Uvts5+3u7CyQjMZL0DlQIZgRKBwCWEhX4C2n3V6QrdV314p1CH1B42mJHOVSowpymE7MTCFZUQDif1GY5EQ58nEuOyPp0cltUrc+a23+/ftZoQnO5wyluC+fIMyaZLvhryGo8MFkuqry5O30LOmWg8bfIaIBhR4Btx2yL4QwFTd8UClWj5lHWr5YMjDBbAa7d85FSp5aNXMwNptK+Srsi1zD7Gm3zPomWVOFcj8AAQ59tH2JougceVN6qP3fXFheVIhU1YAeiLAZ+AuSlVveBQgcBQ3nPIPkGXkPftKrGFOjEh6qR+KZbz8InaklzNA/Q6muoUJxkl0ZTLO1bMEBpRNY+nIU88k4lv+g1/t5p6qfmryfAnT5/qVy9+fX5++V8Xr34Exix3i24xsKcJVx+ZuIsZCo4VO7JRHLtsBZKDI6SpPJibteqALZzV/djqhQR//+Bg78d8G3AuNmPUIzFTQdC7DqMZhJ1EsPAVfDBy+EDlb4O12V9Ad3wup5pDcfnspC/oTmOqxxOqXKnPMYgfto2OCM6zGE82+LO8GUvV4FhQBefcJFAJIYQJwGyJt8VoO0CEylPGwAnZrzPo7H4czQAPVvAz4NAK1TeFzdQqeT5XnaxCk6wLQ2TfWNP5HunDZ4rqqLodFvRtaKBd4mfIOhfslM6plXcr94b73kP/kToYPW7T99Z9e8k8TvMaF2q/2zcpAF15qNwD0wlSfAhPtsmnthnnKlffSYsWV3RLWorOLSEVe/sDwRTGKSwSWPBUjlW3ZL0QddXXlx/9q8fO2j+8VvPDPx6/uR61sfqZ8mRGJyec0Ji7gpdIHuDJyQTJQMAi6oVf8jzslSUYAleHyQXbw7A0no95GkaGBLuANYOLr4ZosibinBVdLl7TaemcWp6fYtBRrJzyuiCKrinbi3OPNneBLucpAnhS9pd5iNmyqDAKe6sszKusC8bhI+A+iuIUsBWrVhBZu8wT8pXpEM9YyM51IKTvQ1xqIJjtWV6CnoQyhj2nzNYhUDPI6qqnvycOW9eXcnwzVkmc4M1wo8oGGynzEct8LAicCLYnYYXXcMzmByjm3TBocALexaDLanhMVu2jNfLoZUW/86MXl+LF4Pnrk0NxYc8+vodNVMCVhomOYa/pTNlwoJxtlBgb+nbvPFUpQ3PnMEjcA29l7NkD/8Mc6kbam/Njm7bzDSs8dRYBB4aBys+tq9JWrjqQr0IgrDD9TtVVp8Go4lD+BicVkH/Fu1WnS83jvRoPooMnbtSFZvVnjLQggHt/UT6g2LmJrfMXx08O9g7o/qtIWr4mj97bPXy4II92dJ0F2JV5WQKHHVasSsaqTfggJZPPr/CsOE0kdPqAMw2kppIeZFbRyIV4iyLfb6weD0AFPMJfkJ3XD+oZHL+BGoEDCGR47U6TllCARuPTvFZcdREDrFMTZgTH0lo/lzQFpfXty7ZpIIIYfsm1PZeNuw1wk111SpWo0gqKyPpjvp02vn9Fmvv4cUuaeyTMfApBXkJ3aYGrsVGem4dXznBKEVaN933xXlFqW2jg75lJmV+B8zMcdkUUkhd+Z0tyIWMbOZQ/Bk7EAmu22A/ZgoysIG5kXipMyOd08XAvARbsZTXEF9t9vlCzMItvurJrIFSYKPmMUM3a4CYmx60wPgiVtQz0+DaLapnQHXDoXjGknBG0wzJLc7nCT+Qs7GK4q0FzqY5A4rbFhzzmZ1hU5mtYqw50ykmAF01j0BdYPXoJixL4ctG/Uh5bDjF6Pzg75JPGerKq46A6fiEHx2h3smMxBBQ4KbJbICSKVYsYNSnKTAPDZdDwK0vjcj8mB+/w1LzgUumSe57VrmEzPoKZWhUfgyxvQmDWvXi1V//dTn6J3aierXcputRJ+sv3xHeQ6+EbWm4oIFwDDWBCbub6NMHaAICFEzlSi6ayEJUTCBqGkUz8BZXpNWe1VIGllqzIkqB9CXzFBSINj2J9Ub7D+vJ142U5prcQvlOkdDaowfj8yMvIzJjA0CUZ8OSDAlkJATGZNgbGmIM7wCOXjVA/Lujm4Zstx154/GeYTMtmNrby3Wyl9S6/FfP6HKtFeE9bVhOU2PPPXCNoqkbl0y+aH6myso+DZYEBBjjfYppnSTTSQav2LSMd22FFzHk0ONvDwuTp4OTRL8cUbbbfo7TwnO/6NUMlmAArcmO+L4ABWm/uiwoHAePMc4xL8NDNkc2NSKmWXxgXris7tIORX1mIDaqldaKGfGxBO9sED/UKI+Bq6FKfoAq3/li/e7u74wEmxoiMpLy/u7uBd2/g3feIi3v0435DrPeIC77kUkoROOPFVEU3QHScu2HS5ikYiXLFOQwnEI6Rq3iHwUneYpGPq1JZCROAQGGHJCuGii2bNbj7MD2CFIif0uFNFNwof7s629sFQUD7Wf+1820w/huMfzNq3GD8Nxj/DcZ/g/HfYPw3GP8Nxn+D8d9g/P8UjP89wfe/KwS/qX0b7P2KnPprA+5b8/ENuF5vwPUbcP0GXL8B12/A9Rtw/QZc78pEG3D9Bly/AddvwPUbcP0GXL8B12/A9Rtw/QZcr/90cH0Lpu9PhNZ/YTUbXP33wtUXIKgvVh1p6cdsB+K1GwdBDhU+eZrKDH1Rf8yQLTk0y1SGeAGsbaYgZlFyPQqimSGVqyMHDFskwiDgXAaznoI+wToNi5J1tZ1/jGlxXokqVB0WNioSF4E3/QVLz4lNf8Gmv2DTX7C+yWz6Czb9BX9Of8HKbQVVECjk9wQ44Po4kKK4KEcjFE0IqwCH21EM1S6Dv0aTQrfzr1YoNAa0oB7oWU7m4By091qH163PQeyFkSip4zl/cXybmqzmb5YAUEvTCPsF9V+Aoy4HnC6gZ18qvxUft0Dr38iY4TV2bAkHcg9bbyHLK/06aFB1Od+oh0uhQetaxV0DVNMGXMpPxVa+EBGMcSNE8Ja2WIdT/f9jTVM1v4ehbbRtPW27W7vTi563JaIWjrmD+3xRIetI/EB3S9r7oUh4uZTlyZghJbUam+3xIvgV4l54QQ+M66NKollRBKZ7ZpNxARQS1r3tRcV3Con3t7migGX7q/AqPDLYeJEX0K86JvOw/BAlVx3EumVTrFQUKy/uerGoAWMxz4e463odSLD2czZbhC3zc+DnL/HEp2g40X8AW/5Q/oW9oLDv8psWt/IdASqtlbu8PlYGOy7q+Fn8Va6LSzBntkYSzFEkRB7kQbgA1HDlTfB7ggPsXzCo9yWxSMINXJUWVal31uct2iqaxaxSHXQdJOfK3WYIcDn7OQ+VrQ7n1c3cIorqMqnFPcBqynPp+lQt5ffK9u+t7j7wWwruLSpvq4gy8LKA+7KqFtAv6GEVDryBQf9HpeChKqAkjB9pMalv5KgzB/e7RlsWaIMX+duMuGGwzVEcw5IIfXMsw4h0GBZD3p78L9bQ8NZSDJ5fvhDnL47F0ydPD/pCDEpdptI2mFlYU/WWAHIOFafAA/ZiA2zvqTCr/LdjgMXy1vzKV+EMlr1uMO6lRRe0yXzr4uVRb+//7iqLdMz5edSxiYxjRfcLg7TkYAYXp+IpOEXx7vKYAaWuM8pebf6B0IFBftXIptO0BnvRCR6028xTyqRO8c5iLf/z6ODRntxXj9WTg8c/7u7u7j06kMPdJhTovHzJIl1DIn0zOlkpwrncD3ZRGTuPBFBZ3EHJS6vU10vRwBe6VkdVwnwHAAcq3oqXey3dA12+GcIF4+VBvgib3PmK/1xPf1fTXu9hU4H44hJiGLrDSAscCkUUpUo/XxB5UazdvUDN2Krrv1gf5FZeahsCZb21iq2ZEn6Et7eIFMMGXJuIVp4qbuHwAg1in22b1DT6+b9Q0tjCYAlBpWRf+6C4u9u57lkpj7IgwJN6QvfyGN0g2Uf8xQBV6kOJ/j7O6O6Zfy6uZeAe9Yus+o0C5QhOJUmUHIO2owjwdbmHofF1BvWYrBjd1nWYixR2dtdCvkUjCi141rJxG/bXGr3Dwsc0WHOw5pct/GexxsHi6BYFfA1NU+MR14ezhBrJPtx2jmL9s8KXH7G8+UzJRCVHwGB6B3ctx1hc71Qvv5AfUwvyhEiUWzgkjurs8O8f7mBA0StX03lRXKmvF2SnkV1zxzYe5x3FPnzWk7Hua8iLwrSvo52b/Q6utd7xKcfuAqmFjOGPWyh9LBjCkQyJ07GlSMH5Dez2RbKMsHFtiZ0jq5Ku1aWWSp4NCAiFiouZMasj4UkL+CF6qU8VOp8ETyOmiAoYkhMb6c8OrfqJ1yg+iS3wX4zKShOpGTkQS09td4Xqj/s1sofCDvzbPMoS5EgPFvf3TxRklhXgtjOkv144t/3q/WVzb+ThLJ7LAv5peUzJrpnKveVFiJyDZIx0mNGA4uRF0dH3r6DZnhc/lvncGUbLt6MUX6uA6eOy1n4ruPYO/bzcmbfVV7VpaZt7tc+cu5PrLeK13u9Frd3Usr2gB5sJN5qm+e0Fvc7Yw9zSmPxhCbtsh65lV2tf7fI+10rnqk2xihbTcu+o7Qd1jZ7VWtiHSoPk6p2PRS3sWxoV78gX5i2Dy377p6038Ct+v6fSFFjqq6u0wNV70PJms4U/21JrBiuOm0p3wkJtsF0/eZ9MnleWhi/pWmjrEVgE/m+Fy+fzLYSYt2DH2xHcnc4i7HQbKLodilrFmC5AYXYqda6FGd5y7KA1nDJUr4yAa2DeFpfESnAu/kqDCqbKGegirFIpH2qCWqgx8uNCTEH9Jt89Xr/7bL23zL/YTFdWUTLv/L3mrR35vTv6qo5R5AJEi+MnZDUO5/aNf+TRQeH19E/FW9WDoHi4EYzlg8TW//z7v7cZCH8xU742k9q3qtVhszkKhnswVUKZfGboSj4Y9Qyi7BXoi620p3OHxUUhiuJClaDWvh5jty2kPOCDUm7hiLAvJo58rkhGQTTWiMtWIRBgJCGC8ug7e9CpE4qKQBmMZyMiEM1EU+mcIETZ9AUKdPbbRpNxZrHU1A0lKA1yuLgAG2nCEPaGzg42G3JPrwuoIH6Bk2S/5fCdzWZ9SR/3QXN37Fiz83pw/PztxfMejrkrCvyFHDAMc3AUF6gVJz2aZf9hf4+/ncmksLrSevjnvJsQkdoXQ+SJx1/jh8ltJJWqz+lOHEgdlr7Yh8P1D/bnyq1BlwJ2MMwJBvbwyO0tJrlwYNzd4dsQiSVz/g3zGwgs2HFg/uDCYjysrzF6hnOP+NEjj4WPQ7BLwXQtKcN4nkdgPBmnS58t5x5npxcYkw7tj6hPKQHrJHKGAQT8e9i56lAZPYrzSzV6/xZO2HCcSXQ5HaZ7Z+tX1aj/mqJ++6KEMpLhvLTKegLAm8F/S6iR6pC/oT5CHP73/HH+ZOGAPGTmp1GaeNP1v3QTOgo=
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: eJztWd1u47YSfhVCV7tAYidpNkWDomiSzRZui91gk6IXmwChpbHFRiJVkorjGr47T3Ie7TzJ+YaUZdlWdrt3RRG0yNrUzHD4zc83lBdJRi61qvLK6OQ0ucmVE6SzyijtRWpJenJCaqF0ph5VVstCTIzlFWOnUisnWROPhc9JpEY7guK4VkWm9FSMC5M+DEQwi/9rR5nwRhg9NtJmgp6U8ywHk5pm/Ny6QbKXmIpssDzK4BXMTtT0Ingzah2BmKU/a3L+3GTz5HTBch7b80dZVYVKg4nhH47PtkhcmlMp+VNleQOvyPG39dmCZlF8mCSnnxaJn1eE3c34D0o9dvPKF7yw4cImftc51M2smIvSZFQE6NbiYparNBelnAtLE7KkUxLOlAT8nJf8DUBChZ48WQ0FN3eeSvHK0hRIRUiaxT0xqXXKC5AbvcVXU+tMtguCfPp6IM42HGj3MRMEDBEJbnJotPEcmTGJEjvJB9JipnwupKi1AspCS1/bYGJlbSBGPkS1Yk2Of+OumWmyvJZRqjIcqtnMUmoQdUBfKo+9ESQOPgRlj3kAkQ2RGNCWwkGwoO5RrJmJFFjBCltw9Eisv0pBObVEJT6FfHrax/n2ld4HQHIsHcI4kYWjve1UyPhvE3gAjl2hjYwvJdIqwWd6kmUV0uDk+M3xoTyiE/r2zcl3BwcHh8dv0uzkZCcpboBMAyLCAuQ3kwIHGSRLthyDPvoKH7hgfmy+DlJT7uz9sc0zRhkg5IhMN1OGW1kUUxTBKtQDIY+vRqNN526CY3/XQRSc2i2Ty1V+Aw+2I1yFTJkoskhYEU0OxDsO/iphb6Op24R7xW2yley3yUBcAFakb+gxKKMCzcIKgG4R2wAwUlGjhudX1gB6sl8DdF+w5fjwqCfYwC41dZGxM3Dp3S976Ic+tE2NnJ2RyEwot1w+QqItAyTGykNRNS461Njb8/PQMoJ4aSwJbnvKrrJ7uVzu/Z1mBdCtdE3XhDpO/ynRsiQ+aBOmKjeakrvtsghSPVhtHv09pGJjoU4ZB+Rl2Q/2poHY4bnlIK05hg80TwsjH7gVCMfnZ9v3KrsX0uFfNnsf0jP4/8UNLlkMiLJKPOoXVa6CGMvXLn9vPLI00sqNQY/8sv5belSh+rij9oKTBYnnyqrfGoRefbh+3WMQWOi65NACM2vQ0AC/cckdduJMey7tt/eZKA3mZ+NRC7nZ5/5yebetC8aJWRjkubpHXYXN/OvYgqHNJF4uo7SruKeHRDw6OHgh+heifyH6F6J/IfoXon8h+n800e/Q+baFTnOM7xoQ/DpNyblJXRRzeJuT5OrAQVj7ONL/ppGx5DZQofIqaZGZ6AY9iodfNTd0K4esNfYC9MmQ8+e3ne13hpbtilprr2Oh4MU0eNn2HZxs2WO+J37rVnXec/Dlsgfm37SsfW6s+ouyHWjefOVI9e+CZqRXAxhZzBUibLOFEZQcpbVFvw7j4lmlfiH+eMf9+JykJXsGgMMKn1pOHaMz2pht4URu+G1WZVzAQrJGMowvt4YblR2dcWG37XotTeMr5GqLXpjk3lfudDjM8GxfVmqgplZqP1Bm+HiUsI9bsyscZB56xoyLj3ss3a2BuOZ8iGFcwdHGQ8YFtCPeLSKJb5FbkrMmFUN+7fSjs6sRk4HghGWKjGnIbxBJPMqibnnnfsPOvYjbiLJ2nvm4wtytntBPwmx7H30U9+IV+DiSCzhSFQGGSqb0ek/QAKPIptlT0Sh+Pze1ZUT24dwP92HK6AZ+kYzDt3ermeLn3292zxY6W8MQlXRu5V601PjMdLjhhGgRDEXIGMbNkrbAOHSh43K5fly/FL1cFcT23YfH38/Ntd0RtW/23J4S27mib/T63EzVJEVbws0A0anpSPjrhYbOOwv9fN1lvDXvdshyTZIrUUZQ6YlZ9UOZhn7YulBXlbH+x7Yo1v6rn9ZLm9W0Ft7pPa2SePW///z3Nc/iUlzPKFMuF3x/wfUwzaWeUhiLUKvtGUPt8oCwmh/DFQ2BcnhSTPadgTSpqW4nzb1GX45xuwLZhmXcjPawZ6amyvOtFXda8nEGMwXmgMpkwlOaa1OYKbo2ikTDAFeNDC/sC1zGijDQch8Nb+3HqCoMtmwERWxQDiyOtAGphAE/pHw4Hi67dRHO48J9WATWh1oGd9jPUmpcMPleB0Ii7Wg9o6LtSJSDOBoc7GA+m80GMjweGDsdNrpu+Ovo4vL99eU+6yzXk/M6Dtx9MpPWPHCv+hM34hivo4Oj48E3g8MwJKKJw7uOP81Mq559Z9Dh2H/M7yxN//Co52FVSDTsZQPmoiGoT82vL6Gdd/ksZxrD48WCr9m/2WK55GW+hwVuBHLShnSLTLkiAua0B+aL5CLCsR8qk8XR3gN9bI0fzGBRgzto5T8r22Xaqw/X3IXHzc9DZRg1EitnfDfC39PkFv+Fn5tCEobxhtcXSYGyq+WU5aNd7g2y6fVrnnsIPNd86LxKknre8XKb8uJh+G/nQrep8j2nIpjnh1Y8PnlWoSWJKM2RvIPT/wckFqq6
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: eJztWutu20YWfpUB/9QuJFmSb6lRFOvYuSgNYsNytsDGATIiR9LE1Aw7M7SsGvq3T7KPtk+y35nhRRLl1EEKLHaRBjAocnju5zsX9iFKhI2NzJzUKjqJrqfSMqGSTEvlWGwEd8IyzpSYs4Q7zjKdynjB3JTjMVdsJJgRuRUJ45ZNUj3iKcu44TPhhGE8Ntri/TQlCunCUzQOpz0xPjFihn/K2U7UinQmDCdBBglEibUay8mZF+HSc8WRirSNTj58bEVG/J4L657rZBGdPNA7DtTokmcZ3vHk9j5bUu4hsvFUzDhdZYaYOSms/xXI42rdGqeK6dFnETumx8wtMsEqQegXToTH9Fu6lG5UB+7bSru2VG3SdMQtHo55akWQWRoBHT9ECtrgcG7SCNqsSyUT+lswss5INcHRsTYzDg0jXIt7Pss826PDg+Nev98Xz+LjeH802o/78fFxt4dD6ypFy1Zg+mTS52LM89Stur9B9R0oehtNRXkEfO7gJhks/zRWvU63020Q/3sgs06f7cgQgGOdpnrun1gxA0sWaO+SBGTXJ3OfOpfZk7294k4n1rO9zMg7Hi/aj+h9KUBIIeLY+6u3DCkxn8p4CmGQRRBlwe7WZQ/RUScOT1rMTnWeJgzRQvc4aYP8cJrFU64mMCvp5CRcBoU+50baRMbuq+z64n1D8jerhEBYqiQHlcUQ4azN00m/Fjx105gb0WAxKEjCL54muFAMXQlKURyB8aROzvnCrrAD7IiJMI/x2z863GRzTnFpSqIs81SZVAhYUAbTidATwzN45kqQNt9uvFcVRTCuSYKXhaJ8It7qgDzfxGUYaLG0JAb6iCyTXAJCF6T2cMo90ZrLSOtUcPUYG2dyscnmmkgSZrtFyHFbUF3iv3W0KrLg4yb8lSdtppUN4NXvdv8SQP5TnN1A7BIeJpQ2yhZ1RiWM7HWKeuPLDYUH5SMyMJ1RciIhtZlwJa0XMNQ3JLERY2FCOqK+3fgAZqSUAewIcxOxnVfnl1e7noWeK6QqqIW3VAwrsoqnL3Hfq8L3qvC9KnyvCv/TVYHA6k5uJHEDoa/KM02M/nEigJQy/pGVhNhMJyJFCmQuh/GKxDWSp5Jmi6KM2ADViB1fN36wzEKkFDmj5x3mZxfp31XM5qFxR8b0djF2LDJXecfKieLEx6N2H+CdJ9KBUudG3ahTKxPBxkbPvBQ3kc3jWFirCe1jneYz1WK8lrzIVGQppKR3qV7AO7cieTriA9VbRTV8F8A/2HOQVJfkWjoEq/wBs/whkqHiGbi74m64+ZrbqffCDDEIB//1FeToaEsFKb3NBuc+4mtVnswrWa3QTVAlg+vcYoi8KcjDH6PcEbIzJ+KpQneREnyiubCrbgF6wiU3K0LdeM4qn5HtN/nWqL764ErE2iTRx+WKa77JjM8Ofuo3tLymcvBrWRiK4dM3I3P0H3VGRMu1sHiyIA+dTme5lesqL7nJijJGJL9JB6O6i6b6fwIwRcA3CgG1gz7ZwbM0qlc0FWPUvZSrW4LsLSGPkookh2fjPOWUumw9Azo1vRlfEBpY2hQoh/BBSIylDwmpOl67LSn1jRYt06HcdOwUG5I3w4t3u3TBGZXZDjtFV7zwt9kZV9rHMITxRWtI8SroNLKXDV5cv2RXL8/Ys+Nnhx3GBs7DIpcqLFgoYMZSpIktwyfEOxP3scgcbBBQbEDdxZqxVn+XBgAUlqZZwZUnW4X3Rv14PzkQh+OjL103DEdsSP5tPt8Zvj5t93wLV8Pbk0Xqd/sH7W6v3Tu87nVP9rsn3e4/mplQ0iUZfIyVOE8xNsUMg8qVdMj4NcAMhhfsGUCRvb8+I3eLqjHjOTLGkBLPFxTvdzLJeRpSp5kN4SkhaGtDpw1SF/Cu+Sr8OTg86PG+OBLHh0c/dbvd3sEhH3WbXfVVMbkIP/EoxpMZEjC31GxSlk4RjGErmIR+tuoEKFjKQhlEu2+Pb9u+rq93A5sibxhivE6YwEhpFFR0vcaHdUqg4aoDrTBukcASHUIlBEmUobyK8PPr4vdp0RvvNwMIFIRpo4eRlloWhg5KjjmQ1XcUWVHFIDOVkxZSOJOwpX+4kWzr8g/LpuXpSqyKCpT6RlnZzlywRKsfHLtVmK1kMXhtnPJ1ypcLTNQ0v+wW64HGyqDZF1rhQhNlPaQXMEa752JEKopUEYEt+HwiKBfYHKXJH5YKnRySqOpHwiuk/BSDlV8cPxDvg7CgWBdhxKkoZGgqqkXzlhd7X7XZWG3zhDHanCElyE90fb7CvrFW2Wzc6re3TUaV36HZcgv5LWFTh8rzLYovl1uc9F7VQNQwzeFXLn3+v0wzAD+jEHvIY5rOPZsNG/mSGmPKdgso/RCdZvJXQZfoKx+i5wITszmFgf0d0ppP6EtHGGcvq/UbpJhq+kiSaeuNwemVaC98M9mrOtggifWsNuZjMdOFoMWmqV51JHjW5pnsSExMynWk3rvrRyTg5ijKJ0XrtY2MDY+3UPpYWyH0ON6HpS0qZ/Bwg9YQRNabMSoXVdFpEYdhCm6AyeWA3YoFo2ilHUCIQRoSBbvjaV4tpj6t0fnEAhs2y63fvADexvIeYOYR5lOQkX1iO0A24Qk4w2XqzZDxWOy2mOhMOhtkT1jx4s8LnRuySBvC/fLJt5+rXn+IRv7XyxLQ3/x23dTNVziA3y36k4xbW4oXKBUyU+e8JgSrLOgz0Jc5/0Jdk8l1EQUp5epV/W3tRZkNq6tZmiO/tGIs/LR9U1htAav13nrwfHHdtr7vCluSzVXVxg7qsRWTXx09sgsKhBvLm3D7kZ0L7VKWfnM21iUWoqJ6jJohUAhj8izTxv2tyonaVvJVfWvdHvXhBu5UL7Gdf//zX7vUMHE2nItEopX2VscEELaGtO+A5eW4yAefujKmMNd3tLrwnS3aPRoA03Hb0ppRoJozPITt3KJVvM9HqaA67G9jvGv5iWYiHfBvTgO388wsXJbA60mY0HWqJ0Bs5IgCAUqa8Gk5FXcipYwkzPbAzkdIKrfwRJDDehamPIQDCgqnBtVHfBLWfBM/BdLYj6DnbJyn6SJsdbycM64UdINREUBCWR/IJYwga5HF/S0xOJ/PO9w/7mgz2SvetXtvB2cv3g1ftOmdZb3wqv1A4JPoOKe9QQlPdcDTINLZ7/R8gwf8hnQr8oQP3l/aq68U2P/u9/oCNJy4d3tZikF0ZbkeKtKH4it+vVUB9E+pZuHRwwOtw96bdLmk2wAbswhf9e+QTOS4UBdL5KcidksFIjoL+revSQA6Djz39WKj2aCSFd4gyMzcF8+ultXLiyHB7qj43wpmvrGIDJ/jJv09iW4iv0PS3ie+fPn7D1GKRMuBFzgT6C6L4W29sN36wlZckGblI7VYkXKzxgVl6C+ptvWVnyn4UGp+qY6HJ4++UFWFcJq8+BFC/wf97r8P
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: eJztW+ty2zYWfhWMfrUd3WwnaepNM+vaaas2qTO10+y29VgQCUmoSYIlQMuqR//2SfbR9kn2nAOABCUqVtJ2f2zVnXZFEpdzv3yA7zuxyAsRcSPizvGUJ1p04ZWOCpkbqbLOcedyLjUTWZwrmRkWFQLGasbZQkzmSt302eVc+AemYaBmBt6IW5EZ/MkNW6qS6XKCq04EM6oL/zKeMXFnRJHxhI0umV5qI1K7Ws6XieIxe/P9S5aW2jBteGHYQpo5G8+NyY8HgzFThX3Q+NSF9WImjR0Pu5SZ/LUUbAqjkBxVzHgmNUem+uwiIAZYSWUm0zJlasoOLOHMLHPR/zn7OUN6tChuZSQcd4JHczeKa2Tj68vL1+z1+cUlrmaa9FuGJipesrlKYPZjNpUCfhyzcSwSeSuK5egMyB87EdoHI1MBTKc5PQAtY+JvHHPDx3ZN95pWc2sfIAdIQCXsOGBHWxnhd7tOY26lM6Ymv4jI9NmXIDrg7nx09uiHU/ut62faOeNQqqOYlMAUGQ4odaxhu4m6Oy9m7pvdHEwohrUkDHHKAQsE0RpahoE1qiLelL2cZU72Xm7WIIiff/RGXxU8M70LGMZNWYBk5oLHorDCuuUJGAMY8th8/qwS7vMurPr5s7m4ew70LeaigKXsI47FlRO1EEXEtYDl7mC9SKZA99evTk57F1+fHD5+giIfB0v2n/2iVdZzJgALVURqAZwbdiOWlibPGU8WfKkdgzjwm4vz77wNgdgSrZC2zApPZcYrlPjheZ7IiEQ3uOstFosemHzaK4tEZJGKRQzmMsqsHyIfXfIqYAS+Wdm5ncboK6mziYmAB0GOG81FdGMZ8LLdUE7KbwSaX6UZbsCZc0PuV/sL8V0Q3Rn4XWlUCoRHoHJTLKtFwRhylYHEQaCm1IwoJcOGeSoXhbUTZP5wOATFZcrgzwPnGNX82rBr0TOZsSgRHAwPog/s2el2qjVHEAM7IOGpnJ1SnHtrfRLGFAKiiTZfgCN3ju87Tg34M1QAqh7faRBayvFXXuDqRgqNT87HaVqSnE87xz/d09KywPj7U8fp4k2RwJ5uk0tQNTzVPv2CQiu+Ira+FcvOVbeDFgHkW++Fj0aaBF9YTs6LN3nc4Gg9ytdB3EqgdHKGmGaDPnmrYiWt0zRhMAwwF1CIREfHsEAe34wANoLVkY3Jqc0MwgYGCP4jMGwypfWQzaaFSq252te/+Zjj3Rw4aso6ECU8OeloU8hs1so9RvEL5JHCOToJ+QyEIwE2bUnyEnJrh7FlxzxFQtglRwGNEHDSnHTop7s3/UilAyRED+QMw15n1bSWnRhuhBKXODYYxCSwQ4zpbgQu9E8M6uhwHEJHNktEGGEynkJ2qoIP8ZuVKTrBhkd1Ow9S0LlatbhILYcNt2hxp00RBcnTWkMoI28ZXWTxiM0KVea6z06a5YQT7BHjRYFhnnSPkekddUfDtwoxLbWgQqMeYqmhOEoSplQlYWVYSkLZRcQ014mVsMMLkapbeC6tSJ0B600PijCKZuYVz/hMpPDrbR2+nFiJqQ3RndqJkBb8zFCSRJauKkQVRWVhExywKLNY3sq4hCQ7I7cD+/MScPR08R3XNxqjEWQcYSCpxWqRkdnBNxuhUCayYFivIGsSEpJ+2DEu1iqnwCxpJRf9QHFQwGDR3G28j3gWiSSh947cPkR6KCLCNzE4+cZLTIfX4i6XxdIvapnb3Mwz2/LFzgjJaM6ov1ytwGNiOZOGJ2+BHLGzes/sJLagWU3VvqD0H9aMjHRHyZus8m8ujOcik3H/k7EzP/APW4+oLFn6d2TlVQ06QuWewzx8eg2mYsTMJalMiFi7utjxZKkLNpiIRGUzX6ODB4qCnY3OTlWaQgWqjIpUUhUhnr66WMWVnMlOFWqPlpFal7COlrZGCWgVd9GcZzPnzX69Oe374LJ2GC3bnB+Wyv1P+rdH67ORgkpEngZoNlwBc42zMTX7ZxfFfHoO17/m0Q1+gGwj6gQMCpYQwi1x3ZZZsHsMrrXzgiGvVI/9flfdVJ6aTkVBzNuCr/Wzl0XrkPrnNSn9wVHE7MODIpGbh8dZx24fhuSgW8OgTG4ZY9SNyDYI37TGYEunxx1Hr3H7wNh1phtmHZoqWPgDo7zSto/cNMEdxzoJ4GgbLSGUvuLFjTB5wiOxc7yEaZALq3m7JUMT5G6PulTJDQEYpIZBKokSpaEpY3xWCJtsXQv9h2W9gPY+Pl/Xu15Xu17bXVFSNrNoPsE8U28+UQo6r2xj97fI7tgUpXB1pK+wgpKFdOwE57pMidI7d2hDn52JKS8TQ1XBmJAsKipj+9qBW6uwaXpYLHXbCEksplZIpXlpxHbUIYQGbGtSN8G+PfZ9KjFV2AQpDS1fNdtQDszRXSJplr6IrKryM0VigYlgB7b/gCE6BwVpSqDHDfOx/kZ7TEoqYjOHZUEbXnX1VSeFQrqR+YVOfqBYb+vuD1EkEgAMVnqk3LGkT5cvL1iEtebUFqFNFi109r7KXa2uPqCvBYZX3UYX7tv0ja7aWvZuG/Q74aIoFJib8wL6HiMKTa1/c6ma3Te2MZQUMCnZemDPNtTN3hibcu3bSCizXGTsM9JH0GLDN6vjbsM8itIBTwG4EqBNd8bvbnu2Nhq6viGBgmDGZaZdq2QrRJoOn1upxyoBbSOcl8LPxuR1APel4LfWCZ2PqdJ4OawtsAFWgdJjHUrDlpwLL6zK89AsqZfnUDtCeVqQI2k0QkimgXhbZmTs5PUII0dT1DW60SqLqiZyky2o7cCVgGIIIArV5vbp4dAIuHXNdquCJtLhrzjYFcGtRFj44vWbSza4PRxYmx7wGJrVAc8lzB7cw/9DAB3Fq4FboQcrjBnqD+gjiUNwhKxiVYAwjcNT6+MGsqYK1wvB2irrgfXJjPoA5WIYhLAuxTBcvgEuLWDzBqI0UcCGXVbXNtDGMLXk4g7a566HZnynAKsVm+bq8RtgJlFLKCfYScbK7CaDLitwWoLDmz7crpxGN+8XtaV1cwUaZ6mzQoH8j5UrwfYNKsEWEJS1XoxPUy4Tq1rCtx4Nh1QfYNyxQoIn1Ag8N0XbCGPuhKjGN5sJdBWCVk+ePv1MHPBH0ePJ4fRoOBwe8KP404NhB6O0B2mpODkcDv9MUFVSoel4eT+EtapiwrqhPT0itOSgzXfBsdsA2JMtaao1/LUdH9izKWq/LcJWQeZEQhebQfSgJii7ifrI+OHCaGt+8oeCnaYh8IPpYXQUPxKPp0/4p5On0WfxUByguVi1fPiGm24EPqibtGA9Exr0h+/W5rxNbfgDUJC70wLmFkzN1Ylpixf7da3vp3RUcrIBNNq1gsNVB/Zh1NER6JBYfR/cezeU+8+Fok93gKH34PAeHN6Dw3tweA8O78HhPTi8B4f34PAeHK5K1kw1ceGlrfg/COat6jgvXJufFPbQUZnwdyG/HkyatoG9Lf2Bu5MW3kfCJ9vC1VzaPrnLtKJEBIUqkVDdcuKaMI/wG14x+4NR3EaR+H4wLlJSt8YP9ySXpwyHbzP0OLQCKq/H/4R/eq9e9c7OLufz4zQ91vpHe52Nmy11rk19oSII2/G3mxotz+Hw8Elv+LQ3/OzyYHh8cHB8cPhj5yGwuWFJYBaO+JoczGrC2I7L3pvy15v8XSl6Du5L2Yujvw+uPv8WWHOoGOgCBzx6T/Ql3FoUhSpOocdCgeHvs2C3FhSk2UPUs2uroMKN0KhKAUDgqmX5FkuqdfYF3kDK8tKwCnJHcWwKBAdWgHlDN5Wj0s6ILWKgzsA+VIWxwNcU8ibs3sUBa6Zfm9suF5hpA28+9a1RREnDNQmo1N0K6wyvMlehEAVDrZCcrvWGhESs3yIlp+aJpLSwbh0Hf2HreJMhtq8K+RsVJE3RPP5LO84oc5f3ncPQNmsysnm4LKRZEip7QucG8PNq1b3vfEGHKicgYHqDXPMZHoxVICm8AgrmCu/l5kqTIDgO7/hziUUFp1oy2s7VzkSqHJUwrkRgrIKxYvjW47nsW/SqL9Xg9rCD1K3VCEAaiGrbMtp+blnpqhbBBVqCVaAXRF0c2hdbEPkTZ4QeaV6Djv1hUX0MVeGS1eEwJZPGOlXF4o8zoLydyjtIsDZOWRrZmH0E4cHWPabgMiEx4FHzx10m+rP+2rLHzE18hocnKBE8nno+pjogVPl9x56qfUl5Gvj45u3lJm/BiRtYpNaePLuSoxmrgAYRrJIguR+VOzShU7kWqo5SKTrq9/X17hfeFRonCyGq+jAGugaBtoGWbXDkdkxtG8B0tQ2leaDNvdrer3xQVR+W9P6MqC7A6zjTWpG6w3u0/anyEZVHFFEhdMqEENk8V4X5e+VctXPIr+pXTa+sB29Er2oS++g///r3x5gEObtYCGBjbpsnD49QKXYbEFwVkxCTbyWdWo4ckKVFMu1pBaMF9AXuAMEsu24+Cij48xc8LGdxEy/DzbSCTMxyBRWgiOaZStRMIpIsMlgAvY+zTCxYAlk9IUwXIzGd3U/AO409NfZ/XQHD8c5KIhEEsK5D7BVihv0M8KPtqfG0TBKMITGQg3RCqZPZe/VgugIME9Xh4xG4P4SDw/5wQ+aLxaLP6XMfStmBm6sHL0enL767eNHDOasaaa/1gFEsVlGZ+g4blsaAbvUFNfij/lGfzowwEwB1AT32bxzYov1sLUjR+79m2/812/6v2fZ/zTb///1rNlfe4IsB5G+oJ1cuRt+74vkn9zduMDiADuZYX8O3+/sJCBYKndUKX0PYKahih2jMC0phtn73RSrV2+vJf2v83d9x299x299x299x+x/ecWsNiDfUl2zcdKPMCh8IAbBj3P2Unrsk5kdstHT1jBNS4zvHhsAG1loweOL+tDglWKdT8AXevIP/Hnd+hv/RkRSV6wQl4fv7TgINSgm9Ioyx62IXxV13XSMLN4QsuB8Yr/2nbBlQuQ4yWGbwv8ha65Rn6MPgJc+r4fbL1glVW25Hoy7wSOi/bMjGTg==
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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: eJzlWN1u47YSfhVCN00KW/7Jz6ZBUZxskj11W+wukiwKdBNgaYmy2cikSlJxXMN3fZLzaOdJ+g0p2bLlPchiLw5wzl5kZYmcGc58880Ml1EqbGJk4aRW0Xl0N5WWCZUWWirHeJ7ruWVuKhhPZ1Ixp1kqcuEEfWJGPEmLfZbpjHGWTLUViqXcccYnRoiZgIxUZFKJlAlucikMgxSumDYTrqTlpDaOOpEuhPE/RimsSLTK5OTKa7qoJWFVwQ2f4Z2x0fnH5Y7pH5T8oxRsdOWtgYrx7yKhXZK+FtxN8aywH7/IxrVgqOxERvxRSiOg3ZlSdCKbTMWMR+fLyC0K2mKdkWoSrVYPtNgWOLaw9H3Y79N/sNmRlXjkRZHLxB+n97sl45ZteWvznHQ5vbipvIlX2we7YN9OhBJGJt+uXc5mGoFgCS9cCWt8iCyW8FxaOLsyJgRGLVjQ/o1lFmfIBTN6HjMfa+n3KmZLbw9FeHDIErMonJ4YXkxlgk0TxUkPZKVseMh4mUoHSfG9ulcXVqaCZUbPvBX3kS2TRFirzX0EQ/JypjpAx9pyO9VlnrKxICtpL7zOcp08ipSQ8NxV2nWl6lKMxtzCNRnPrWiG6GMkKWbhVG8ppJ3Knz6W4fEK+2kRvPIn3PKnSG8VL6DdVW/Dyx+5nfoozIR1fFZEiG9hCI9OhgBDVwsGnSjTZsYR7gjP4hkbfRBPT45fDYbDoThLXiVH4/FRMkxOT/uDVlDraAOv0WrrKC/WtQXiloL35HBd2nxBIfHiEY9x6RikMSeSqQJGKYm5pRRuhAW5jZDcN4y695pVOSPf7+otNNC+IAOaH25Eok0aPawaofkqN54dfzdsnfIOiHv/M8GcsKcrDE+5Y3NuGxkRrbZg8WJDlnEcr/ZqbeqSu6ooY0T6q3RwqnvXPv5Y61xw9Tm1FeC3lY5USqTikx06a6f6g+Yic2ycc/VI/LoH8mxOSY7IJmXOKXXZdgbEG3kzviA2sMg2hBHwASQy6SEhwdWr/Sn1lR6t0wFKfP04IBbDwX66fff2kB44w+ldzC7ArQv/ml1ypT2GYQyJYbeEV0Grkb1sdH33ht28uWRnr85OYsZGztMilwA7VS8CTCZFntoaPgHvTDwnonDwQWCxUdrZcVbzd+0AUGHtmgavvNgrfDAeJkfpsTjJTv/Tc8txpIbs3xfzg9sfL7qDQ7JrQ28vNmnYHx53+4Pu4ORu0D8/6p/3+7+1M6GWSzZ4jNU8TxibohKicqUxOX9DMKPbd+wMpMg+3F1SuAUj88hMXiJjDB3i9YLw/iTTkuchddrZEL4Sg3Z2q/S2qHeIrvki/jk+OR7woTgVr05Ov+v3+4PjEz5GoW/jNkP9UomgwommI7RJJaIRsnQKMCagWAc4O6q3tXs8WOpCGUx77maPXV/Xt7uBXZN3HJFtCyYyUhoFVU28EYLlRBpuvaCDp4w+aSbRIayNIIsKlFcRfn4Zfl+G3uSoDSBIEKaLHkZaalkYR93NOJjVdxRFVcVgM5WTDlK4kPCl/7iTbNv239ZNy8sP0TQVLPWVtrKDuWCpVt849qj0nMlAMrurfJ3y5QJNMSLnkK/0b1f51XZbfUCtEbYon01DwLR/WPXmaR3TrMxzqstTwVPfMy9J7HHoV7eljzmxe4HuYN1j79k4+KJGt9mvCWO0uQS2yeH0fNVQ/9BpNcXbHdhm9yaWmE/ExFu5DiBOttojfk/8NzF/vefge/3/QW0YZY9rjv+PXXMjrC4NOBDoRXdZqraDTr5wSPrfctAI+oxCqQJjPYF6vZodH/nmISmNdAs/3F4U8mdBj+igl9FrjM/CXACB/g2dmk9oCg68sGnH8QWGTDWN0YEO/NxM+6JemKt71GF111TSW+5Mw6swHz3tH7OvxExX58C60lCxmjpX2PNeL8W3Li9kLDE6KhdL3XsaRmT/toxbGF/1oPvE2PB5j6SHjZNCs+dDXLtqHSseXlSjf/DyZvi/qPLYY689bb8fsUexYJTtcEcFUZqWBXvieSnqbvHTlpxPLKhhsxK1dux5PpPPIOM5pgAs9iaxT+wASSK8AGe4zL0bCp6Iww4T8STeEXvOqo3fL5Bi5JEujPvhk+/Dm6BYRmP/601d2X769a59Nl8WUPkf0agV3NravCCpsplGiC0j2NqDPkF9vfcbNs0JhS4iDEuV6TrTURl9Bs5wTsqgsii0cf9Yh3QTEvnPzattLGwWt7JqvYkd/Puvfx1S48PZ7VykEi2xnyLQyU85+iB/bwGkyawKp0eeTChK+omuIHyHiraNBrk861qN1QJVmeEjQOAWnWo/H+eCOjr/GmNax08mE+mQ3XManJ1XZjETp6zQaZi0da4n4COEWEEAxZwzJeaY255EToAiRvK0xcfAhFt4IYCgnoVpLdHgHMmp0fQB88czYuKnORrf6VqN+YIfbme8nTOuFM4Gp4JqhbKeA+ssAOgAwmHcb/l8Pp/H3H+OtZn0qr2298vo8vrt7XWX9qw2F1ebOFDupDopiUfq7CIaCfGigSI+ige+UdPWwbqGPeG2b+f2cBfBjQryX7uqrBDvxLPrFTnGSTqPd+CyItqP1QVmdSXSbR7nfPfqEZQGYxztWi6pqftg8tWKXmP+Nr4AwInceOQFPoYxeE733xM0XXRwU5XRQ/bZ29G9x6l5VBGJetYLvfIj0Wzr9nRFlzwVR5CBYRWRTeEa+1sVf9UsVlfXv1zfXUdhcNvm8kfP5dUDKdhr3i6tByvoLxWgvVu+J8CCXX9YLw9fPrthTYRhNTnrAaX7b1PECsI=
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: eJzlWN1uG7cSfhVib2oX0urHsuMaRVHHdlq1RRJYDgqc2ECoXa7EekVuSa5lVdDdeZLzaOdJzjfkrrT6yYGD3LW5cFa75Mxw5ptvZriMUmETIwsntYouoruptEyotNBSOYbn0oqUOc1SkQsnGFdMPEvrpJqwlDvOCp3LZBFHrUgXwnASM0whKNEqk5Nrv+u9X4MlBTd8hhfGRhcflzuqPyj5ZynY8JrpjPTo8R8icdgl6WvB3RTPCvvpl5cIRa3IiD9LaQR0OlOKVmSTqZjx6GIZuUVBa60zsDZarR5osS20ssLS9363S//BUieUo0deFJDrD9H5w5JVy315a7ucdDm9uBVP0tIZWjsnumTfToQSRibfMlMtYjMNV7KEF66ENcxNBbNYwnNJnq6MscEHCxa0f2OZxRlywYyex8wHSfq9itnS20Mx6h2zxCwKpyeGF1OZYNNEcdIDWSnrHzNeppJiF9+re3VpZSpYZvTMW3Ef2TJJhLXa3EcwJC9nqsX4xnI71WWesrEgK2kvvM5ynTyKlOL/3FbataVqEy7G3MI1Gc+taIboYyQpZuFUbymWrcqfPpbh8Rr7aRG88hfc8pdIR4oX0O6qt+Hlz9xOfRRmwjo+KyLEtzCEQidDgKFrDwatKNNmxhHuCM/iGRt9EM9OB696/X5fnCevkpPx+CTpJ2dn3d5eUOtoA6jRausoL9ZFDrqcGCFmhLtdBe/J4bq0+YJC4sUjHuPSMUhjTiRTBYzmiAsHRG0zLDzPEZL7hlH3XrMqZ+T7Xb1FnZdbH25Fok0aPawaofkqN54PvuvvnfIOiHv/K8GcsKcrDE+5Y3NuGxkRrbZg8WJDlnEcrw5qbeqSu6ooY0T6u3Rwqnu3f/yx1rng6nNqK8BvKx2qlEjFJzt01k71B81F5tg45+qRScUOQJ7NKckR2aTMuafd7QyIN/JmfEFsYJFtCCPgA0hk0kNCqtif7kBKfaVH63SAEl8PjojFcLBfRu/eHtMDZzi9i9kluHXhX7MrrrTHMIwhMWxEeBW0GtnLhjd3b9jtmyt2/ur8NGZs6DwtcgmwA+EeMJkUeWpr+AS8ozIlonDwQWCxYdracVbzd+0AUGHtmgavvNgrvDfuJyfpQJxmZ//vec9xpIbsPxTzo9HPl+3eMdm1obcXm9Tv9gftbq/dO73rdS9Ouhfd7r/2M6GWSzZ4jNU8TxibohKicqUxOX9DMMPRO3YOUmQf7q4o3IKReWQmL5Exhg7xekF4f5JpyfOQOvvZEL4Sg7Z2q/S2qHeIrvki/hmcDnq8L87Eq9Oz77rdbm9wysco9Pu4zVC/VCKocKLb4OkMCYhux4QsnQKMCSjWUftD9bZ2jwdLXSiDac/t7LHt6/p2N7Br8o4jsm3BREZKo6CqiTdCsJxIw60XtPCU0SfNJDqEtRFkUYHyKsLPL8Pvy9CbnOwDCBKEaaOHQTsIvmEcdTfjYFbfURRVFYPNVE5aSOFCwpf+406ybds/qpuWlx+iaSpY6ittZUdzwVKtvnHsUek5k4Fkdlf5OuXLBUNdRu+DfKV/u8qvN21y1UWndeyyMs+p/k4FT31TvKTtg9CXbksZc2LxAl3Auok+sLH3RQ1tsy8TxmhzBQyTY+n5uqH+obXX/G53Wpvdm5hhgBATb+U6UDjZ6oD4A3HexPb1gYMf9PMHtWGOA64Z/INdcyusLg24DihFF1mqfQedfuEw9Pdy0BD6jEJJAjM9gWK9mh0f+SYhKY10Cz+9XhbyV0GP6JSX0WvBjTCXQKB/Q6fmExpzQ/5XIzBew4qppgk5cIGfimlT1AkjcydQRWdZz7irMPU8HZ6ar8VMV1ZjXWmoBE2dK+xFp5PiW5sXMpYYCJWLpe489SOydlvGCKZWneUhMTZ8PiDpYeOS0ML5gNaOWUeGhxfVJB98upnlL6us9Ujbn6HfD9mjWDDKbQCzAiTNwII98bwUdQ/4aUvOJxbUsFmJCjr27J3JZ1DvHL09FnuT2Cd2hJQQXoAzXObeDQVPxHGLiXgS74i9YNXG7xdIKPJIG8b98Ml3100ILKOx//Wmrle//H63fzZfBFDPH9F+Fdza2rwgqbKZBoMtI9jagz4dfRX3GzYtB4UuIsRKlek6r1HvfL7NcE7Kl7IotHE/rkO6CYn8afNqGwubxXs5tN7Ejv777/8cUzvD2WguUolG188G6M+nHN2Nv40A0mRWhdMjTyYUJf1EFwu+70QzRuNZnrWtxmqBWsvwESBwi1a1n49zQX2af43hq+XnjYl0yOU5jcPOK7PIpRRFOA3zs871BOyDECsIoJhzpsQc09iTyAlQxD+epPgYmHALLwQQ1LMwgyUaDCM5tY8+YP54Rkz8jEZDOWLGmS/v4c7F2znjSuFscCoyWyjrGa/OAoAOIOzH3T2fz+fzmPvPsTaTTrXXdn4bXt28Hd20ac9qcx21iQPlTqqTkqb6OruIRkK8aEyIT+Keb7+0dbCuYU+4uWve8e3Ct1EsvubasEKsE8+uU+QY8sge74BlxYwfq8vE5o3FxfoGEBw0hfW0bLmka6cPJl+t6DXGYOP5GafmxkMlEKi09JweHtebxzq6rarcMfvs7eRB+2viU2Srp6nQsj4SL25uL1d0yVJlM1kWPhMtFK6xca8Sr5p15Prmt5u7mygMTtus++hZt3ogBQft2iXgYAX9pVJxcMv3BC3w4A/r5eHLZzesKSusJi89oKT+D3zewuc=
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: eJztGttyG7f1VzB8ijO86WLHVjOZKpKasrFrj0XHbWyNCO6CJMJdYANgRbEavvVL+mn9kp5zgL1xV5XsyfShsR/kJfbg4Nxv2LteLDIjIu5E3DtZ8MSKPizZyMjMSa16J73pSlomVJxpqRyLRSKcsIyzjZivtF4P2XQlmBXmRhgWS8vnCbx2sBYAGFcxS7lZWyYd4zagiIfsdOFgD4L6pX5jm4UzLVOapdoIJm6EcrZPyBBKwx9TwhbkAXINWxxbSICTzhNnhM20soJFWjkuVZM8qQDQ4g6eMOtAEsNev6czYThKYAJy6cHGhVyeE5Xv/T6AybjhKawY2zv5cNcSm2CTc6YXjcOcDrziGeKWp1kiAPjZc36wOIyO4mPxdPGMfzN/Hr2Ix+IAgCQiy7hbwbOC4+BXQAaU9XtG/JpLg8pzJgfd2WglUt47ueu5bYbA1hmplr0dvHJbOsxKOnXX3yf5NT3wZMjeKflrLpiMQehyIUHSgQ8L8p/rW6bNkitQNm5ApnKQ7kKjMsFYkCZhQfjvV0Kxrc5Jl/7dSvBYGK9pNBoZgX7yoJJS6KgUXECFiVtXnI78x500IELumEQLWaKKnRc7T0DYfju87qQeLQpNpr4vhcfGZtHYM2QvBb8RtO4ZYjp3hRz2EAw/qo9qWmcXdti6NJhWyZZtCmHxHDCA3NEp2Ua6FTjbXHADgDyKhIW9ei1UTbwdOxQ7fTNha7FtitrxdfDOTlksjE7pbdhMwpFLBR7YoBj8SqPawjkDBI2AW9Qbv0dBcxlcF4FBVPcSQQzM3rybstHN4ci73ojHqVQjnknYPbqD/38U20m8GwUMA8AwY6g/oI8kPvvb4DKfexVMYnhnQ6Qpwh1Zk9duna+asND6pMqRdU2iz8DCHHACukb0/ujXZon4NxhX5KIy9zmEqIDWVjbQxXCag9mJW2kBNz3PRaLVEk8FbKZtrgEImUn0lkKpYrlaK71RNafFaLnnw93KKZyH/KBA6mNtEwPBeeq8UCDiLxbCAMAelWALKdia92L8teAy8ar983T6hh2Px8MiunkhVfGtKdpGkAsZ6r9EuXpQff5CHPDj6On8cHE0Ho8P+FH8zcG4t7tClD4nWERyOB7jfxRtlMNHnmUJuhPwMvrFYnS8qx2aGYxUTvrdIRzTtiR5vaBkUJH8oSeRBx14yfg20Tx+ZxL4EU6cIhPAVT7HcDwX8QVlO1gKCRU3WhEZ4cDs8Xkts0ub/CQM6MWTCatOphB2gf0eMBgEo+e/iMjRS0dSqdJXM/ifljnKe1weInFn+Kt7CU82fGtDuoY0bbaQS0USl67lSeiDhZMHzWzdb9AImuIEabX0uk/svfmpKEoel113hVo+/8C2G4EP2iYtmHvrBv35p3U5b1MbXg0k96AFzC2YmnlVhLS8uMDrfT+FYyGklPAQMIW8gTBIuJAOX40hVVg6YdSxEeiQWK0Z+MOMvn3pqSmPqBdLAVNTmSvnMnsyGoWVYaTTEULbkVwaDt67a7rVgzSceWCGUPvlWp0ClafozK3I0G8s3Q42m80A5J0OcpMIFekYvPdq1+HdFWUtJ+2KBK3qkpRAZFsvxDrlhUD7mJKP2NLoPLOoVEijMs1T5PSgYPeIcWPQiSmxrDSYDW8CVmc1zc2IBZQ8FtNEBdJIJ6GSSyC7FfZCxDTxxFp4cCNSDZVVnHuRCnbDE8jA7TARYfRW7hVXfCnQYt9XYTiIlZjq0jduhPRU7KxLksiylYVHESRgKs0wE6pY3sg4h0Zh6R3ClBII9PRxjdu1rUr9PnC3UWhH+C7PYmQLZCKhX+KOUxp0IrUPm+plaRaevppZEiaPewiKc5I6un5jPeIqEonPJoHcIWQsvWmsYMppLUKFqa/FbSbNtkAa+pjWYQWzHW/8jjoZzR3Vm6vdDpPfUjqevKca7rHqPfebiuq9odoLyk6vJ+fHP52FN6Q7CpdklX8gY52BoSkZD7+eBfMD//ClDEXAsEZWDlbh8U1Qua9hH/56A6bixDKkUCVE7A2LzQJPoTWoDqhKPjomwbbgfHJ+ptOUgeE7HemkrCIL+qAgoBQBLRtgCia70Kg9QiOtzQGPhURCxV9FK+TiFVfL4M0FvhWd+yBaD0Zom/uhtEZr8Wnp6+HN0f5upKAUUUHDCZuFjvEad8/61e8QxaC8xlp0Vsd/zaM1voD4L6q+5YYqokBcv2MXnB6Daz0aYZ3Xj+o3cdW28jTW0MS8nzx0vi5k0QlSPV6T0h+EImYfBsKK7WG4MNHpBENy0K0BSMl7YKifbRHetsbakUGPj4Te4/YB2H2mG2ZdN1Ww8AegCqXdD9k2wUfCBgkgtI+WEEpfcbMWLkt4JB4dL2EbjefCvsclw/pMAWTHnU+GPtHgdBCpwXFglGibQ/DkSyN8sgWRaBP/dlmvRvsQf19Xp16Xp177U1FSPrOEtqo6fK51IrhqnU5DlhkO12b9zgoLR5ReZuAGEjOMr/jLdu1hBgnUz0WKOq4Qrs9PGnvoKE9C5YDTh8kPWO0OLuVScQe8zsph0oIJHq0qau7rDyjzYH0WAePQ2+OgTarQwlVc+j65z6ymRASFKpFQDlW5pZlH/R1w4mXQ0aZ+hsRbRSJFed+JTF9esgirwoUvF0NFGwp3Bg0GUVK1xg/3JNMzhuD3GXpctwIqr2d/h3+DV68G5+fT1eokTU+s/XmGTVfK3T11rk99dUXQbCd4ULPlORwfPhuMnw/GL6YH45ODg5ODw597YMdXXV1BOXXfG66X9Ye3/FloD+H40MB7iYO0dv3G9KIYb7RmCt6TmhPkH4HwMPMCSSPA8fjgk2Yr9aOFMdqcQQeF4sDn89ppHTOOZodQ7a50TmUZzZpK8R6Px7sO9B12UmnkezAtqbLcsfIOAMXRFsg7hbNZbeQ/KKHsi+b4dyyat8Lq3IBP0H2NzlXsTbQxUVlxiq+FUdP8EG0a2y/FJufUbjVuc6r7pZa8n37imO//S94TOM/QHZe/q6Nj9mTk81ZupNvSFPOU5uzweIW3Rd/TJcQpGDStINd8iXdf5VARloCClcY7M68Gmnjihl4xyQ+aGt2V11g7mm4iUV0Xaeci1YFmgMtxrFQOgWJ4N+CZHPrZz1Dq0c1hx83WJRAKgrsPjfWvOzBdVQK5RLvw6izEUpVWfuGeefZpCAHFnHZv8FpctVSXOOVUL2QGn9NmDTxlvi8uA6A4XMhbSE/+/sTTyGbsK/AvXzU4w2VCYsigWHrSZ2K4HO6hPWFh47d49YASwcud72aUResGcNfzd1J/oiwHfPzl/bTNW+2+CuzT2oI8jynQjDm0QQQrJUjOSMUCbeiVjoaqo1Ql1UIXXs0j8mpwX5nQFC3LtHF/LFVaqUT+UC01baECbnlQuYl99e9//usJ5U52uRGQU1e+4C1aWuoub2plT1kAQFy4kXTTNAnDByuSxcBqgBZQy4Whr9v2w37M1qxqT/CCk8XNGQceZnUiY5ZpqE5EtFI60UuJ0z+hAAHqnDMlNiyB6i6hORxGA7pvnYNNOH/Th1MeUCaCQxcMoREbN68wYs+IJdagwI/1N32LPEnQcmMgB+lMuVLAGwgVwqqA6hDVUXgBGB0Y4eFw3JL5ZrMZcno9hOg/Cnvt6OXk7OKvlxcD3LOrpqOVHtB3Yh3ladEVAWoMI15fUDcdD4+GNOfPtHVAXY0ef5tfJI59062lid/pFxDB0bAtGEF3BZFtF/R2F0L6h/BdBABXUjypvk6A4LkCsSPg3d2cW/HOJLsdLkNzbCitgLq4IRv3kb/sy7o+Ranr5Ku3ITk/YY/40qKTlyJ2KwzcFGnhFzyuMbTXPrLY4fQ+RKRPI/LLBxVfPqj48kHFlw8q/ocfVHRGOh/RWp9VlDEPC2YPc0pKqb1rdUi7eo1/fvHyYnqBV6ChJqzq4TXVw+EBw2ZnuN0vjT0V+Bdp6tzyLboSGOt3Jbh/c++Gspj00CgSHAP+B6M4kTk=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztPNtyGzeWv4Lii6UUSV1s2Q5rampkyY7pOLZWkuOaWK4Y7AZJRM3uHqBbFKPS23zJftp+yZ4L0HfKoq3sw9SmUgnVbBwcnPsNvOmFygZGp5lO4t6odz7XVqg4TBMdZyLSNrNCRpEw6kpbeMWKZCqkCGUmhZwZpRYK3gvVVMcqFEqaSCsjdCxkLBIzk7G2EkEPe/1ekipDf4xD2ClI4qmevYUdDj2cU78JvJxKIxcqU8b2Rp9uGlh+iPW/ciXGx4QN7DT5QwUZrNL4bSqzOXyOYT38hagWO8DO/Z5R/8q1UYBEZnLV79lgrhayN7rpZasUl9jM6HjWu73tNzd+ly8mcD7Y1aggMaEVWSLspU7FNDEilTMd83HFoYjVDD5fKaCDyGOjZCgnkRJXMgLUp0BUKyYyuEQIX3a/DD32cDCzKtFPplOrshrWsNZ2oQ0cUzNl4F3gh8yjrDfa7fcWOtaLfAGf6TwObKQXOmtuWT/rL/IaF4q468xGZbmJBXAUT62G34rgHmD1GdfaFPiuLL69v7uL/wMByYBl+FGmaaQDouzOHxaxu6lATw1KVqZ5dY3flc0LGcl0FuGD49qLzdMfxhX5RlSkBuHP5krYVAV66tBhdbAgLsDaNDdpYhW8JWENyOVE4VILIEA5smQoQCxq2wrQtjwGITFWRiDJYdcyMVmJHxYyXv0AihXqKx3mQGDYxST5bA7b10CeEpOGFzEc6XoQJ9lAxwMkykRaVfCmZNannkMblY4/HVco0Sc+mCSKlPlgotrf71CWYFUCzEH5ieRymkcvpNWowaC98yR8P/1AoGWAugAfQFFmKstQF3CJnqpgFcBnkII6I3XYVklavpDA1x58VtdykRIvnx48eba3v7+vngfPgseTyeNgP3j+5Mf9Flt7t/0eUluzEN0P+t5wd7jbAnUOsuBAoRRkaDnrsgGsW851gCwC1VGwEvmKe1jEoyTkuPOo9e3Y2KEAluvqUJA9XwXz4fQtwiEDXi4VWwu5QrlLwCyg1OmpiBN+S8dXSXSlwu36bsT8r26Hb33Pfk62Rk1DfELPQXdCAMZEJgbUtcvO0XfBNrMEOAUeCjTw41zFIgBznAG+LVfWJwpHMlM2E7y5V8ncsjZONcDEt5wRY4veF6S+VZ8nZAjGl5aHIBahwtXBXMYzJXSGTpKg1F1ppK5UxNq7znCdeH27n3rHrKU5SMeD69izZ7t7nToWr5GObtDHjpJEi8KcdEsS0sy98nC6/GtVjz18saXZjE9BZpMlG3+1gC0FwyYJzbu1rnv3eZaldrSz454Mg2Sxkxp9JYPVYM25TxQAilE0UHXBsVSkHVBZ1W2QEic1ocWwow96kORRCBqW4TOJp2FZdtKI2iEyDSyDA/2RG21DHWQb0fXlhxbmb6qAbjHWCHOAsjoDcU7M/UG/VjLK5oE0qm0UHUjgC8GEXVCGThVGDvAKEE8n4bFc2c4wpHO/x08PmtugVcGQh4Fi1ANQUYFDhAybzlQyMzIFzpwqPM33E++nAiJsXIKEvSwcFEKutwl7me/a5YxhicgDA/ggWSY8kSZb4bHP5pKAlrtMkiRSMl63DcfUrazChBAoAkzWceug3t46jh1mgPskz1SVUdIYiQqhM7Wg5yC576eUDzRtYwe/ZAHSx29190ypDKAdZNEKlEpSMBagewrAIw03ta9VDB4+ljnosLP1U0I2tLnhfdfGvW5pC/B9ynAgBs5kHChxQRtd9DC5ueiBCF2Q2a8Bui8Sr3JwqHFl0zLKbZ+5/KuFIimHiq2GSFNnq/uLrGNqQzVKSEUAU9sKpEjNErO6/0HBGkHy0nGqIweqeyMbJOkGPEWT31Z0hCG82BIvmxtRetjUq7oYVyzRnXp6t3Zizs/pZAXaXdpWRwJitxAChu6YeY0HeXz8ce+XDx9/W724PDl4+9MTc/7P09ejx6Ojt6PnuyOfjbbYAjuhyYfUjCocmsSO9YzTzwdAYn90hGcjq6TE+6k4VTMgEFdKRk87w5Uz2pwwoX8+N1XvQSzgBbkDnx3eO9T3C24788mvgmloeAVaNb28N9Xb0kdQxATBFCakCL8HPvMWOxCKz2T0ezKJ9Izj+R3OYIBe8BEMA3yLsQTKMTxIc3gz+D2T9pIXg7gAQqp4B/GKsRLzqec2wQS4sYlPsCUpTn0TytCLTXhxaxOUhWrq/e2U+oWgII0g9QHKxGind8hu/G6T3IAbcH/lWAD53SpzpQNVHhMXsHt37/fcX/X3SXpTLUFmvwfdc06mQAbjIkZW4vhkfAiWJk0MSfdMxViEBBMop0AwLJ7ACz2HwVm+WEizulcijdt9OI0EGCfwVZhLVrazmM3wrhbCbwYrVBbUakMQdYMuAi6TFSSPK+F5qDhWQnuHlkbPYpnlhmhzPZheDhZJqCI0A8U3LQPhv6H6VA58hFAcceQYDB7WE+WtYoEVLjOH1IBqui5NDcAg47oFnEwDB0SBlt2+M1utInnPepRcRQn5MFtZy8Riw8WS2Xh4UizrePpa2nnjG0RMhS9WhOsCyA6S9fCR20FX5PaeiFSQOpUWawtUDQZRsAkY0sOTcVGHt2Kp4cB5hrVuHYqtk5+3++CSgJgsdyBSwCMQImC4hHgsNCDdF72+0EM1hCelOGTOymMquFKZwGSiZLJnC5cyYvAK6ppaAPi9kRgQDcmuO1LfmzI3w+HwtlOFwK2Ce3UAC/Qs8aZPxhgSioAU1sJJ3py9fwfJngGf7KssIJSgRFFoxU0H40cCtu6LNSLR8S3LVscXh+ilwSx3fOVFqeOrN0sL+WuoTF8UUuZe40N+ZNaySJyqKVgACLDdK6xN50Dj2oP6a7dDceYoUiMTpt5DMWYXV6hS3QpOFDAM+b2CtA9kCWnfLRJbKBNzgk7il2EdDd9ooOSLDZXi3tQkC66rODZDTEJlNN6GLPFSmtAOW/bufuKlVm/mk58C/V6/efXby9Pz/zp78yMQ5m6z6JGBM8257MfAfVBQUqw8kQuf2GQr4By4kLbwYFLUKQOuYtW0Y/fP4MP9g4O9H4tj7O/ut4PDQ7FUUTS4jJMlxHsEsLQV7Bg5PqDmg8Wi6K8gOyHXMe1InL84HgpqBC70bE4lI3WdAvvh2GiIwJ+l6Nngz+phHFSLa0EUvHGTgjpQoORWEW3L1W6BiFWgrAUPOWwS6ORhDM0YHSvYGTBopejbUmcaJbSQyz1OoInXpSKybWzI/IDk4ZrCNiorxyV8Fxpon3FZ0s41JyU/de/Tyr3JfvA4fKIOpk+75L3z3IFZpVlRXELp9+fm1iQ2nFRhgcmDlF/Cm138aRzGm8rviOYO67IlHURvlhCK671BMIVxCrMEEF7ImepXtBeiriZ+heu/N36hDkeXajX68+kvl9MuUr9QgczJc4KHxqQRrIR5hJ6TAZKCgEY0K65kedgqS1AELsuSCXbOsLKe3TwtI0WCUwDOYOLrIZpssLggRZ+rxuQtvVErEkMMOkrMqUIQJcklSm+eFhZt5QNdTkQE0KRqL4sQswOpOIkH90EsqOEF6/AVMB9lVQjIiuUiiKxTV1FxTeq+gLRYR0KGIcSlFoLZgaMlyEksUzhzxmSdADRqZNct/QNR2Jm+jOObmTKpwXGKVnkLDlKlIw1OECNwIzieBAwvwc0WDhQkDIVqfAzWxVqaq+gU7cMNMuS7qm2nh6/Oxavxy7fHI3HmfB93wY2KuIYw1ymcNVsqFw5Us40KYePQnZ23qmRo3g8DxwOwVtb5HvgX9lBXEgiHwnjk8nLub8NbJwlQoJioAL91UTnKRQ9yUwiEFebXmbrotQhVOuXvMFIR2Vea8nCy1Hbv9XgQDTxRo8k0Jz8zhAUB3MezqoNi4ya2Tl8dPTvYO6DGU5m03PsAEC88GezuDfYOzvd2R493R7u7v7Wjcg/Xa4DDLMgNODssFVWUVdv4UUYqX/TOHDttInT2iDMNhKbMADKrZOpDvHWR73eWbccgAlhJs6znTUe9BPcbqSkYgEjGl96bdIQCtBrfZlwR6zIG2KQYyyNNdxbZuZYoKK3vRtulgThC8msh7QVvfBneb3bRq5SaKhiUkfXn4jhddP+GNPfp044091DY1QKCPENNrMgX0SjPLcIrrziVCKtB+6H4qCi1LSXwj9xmTK/I2xkOuxIKyUu7syW5kLGNFCpeE37STGyxHXIFGVnMuTkr72wODz710blXJgVclxjii+0hd7LckMu9JbhtUVrTQQySLEasll2jPraYGcKhBhbV6pDNQ2HDu3nfhpYVo8kljVM4OmmuVIRGLuM+RroahJZKCMRpV3cown2y6zIPNSCqI51x/B8kixREBVBHA+E6818vtNcqY3fPdn0cn4zYyTgjVrcZVDsvmeCp7J061kFAdk2Z2AIgUWItUhSiJLc1YSI9R52vocYl9nII6qtVR0L9iPVAvPXrIMihwidvU9thKJqvWdIlP82ykDE2gLXLFMQyMZfTKFlaErnm5IBljcQxCPDLoNYLkCfA0zIrWVa76cczLd4qUYWqx8xGQeIiMCz8gIHDGVeG7+gx3a8FnHMUwtDqszmIb3v8ZtOmrxs7ABb6BnqrgLhZQ/ZOPxHefSbuf242W9HRfsFRXusGKvzOzW2ijYcP1m7kQa3byo3HHEPcNEmkCdcU5zfc1UEFkjqwIjdRNwrcXgOWxoepPqv2z77e6jyvpjVuhvQ9QjoZN2YFwyTI3Sw1Apj4PAvefFROZENOQCYOcwMsQ/iJaq6coXycUaPluzXH9Xf+M1Sm4zD/ryt/ma7cUoPAT8LfNYF9Ur7VavKzi4M3qpJQHSCvNeqdQ8RRdFcKqB5tD7OlJJPRuDGgsA7eOb5cGXwn1RHySurIzS0XsPcPPHDE9VuAI9J4FYDyvFj4yfxyHo0iBHz4ddjvGij7+fwaNXYB4FzaExemdAaI65IqPeV61SMsVxWBTnML0n7e5Z26zr59hxhWt6DjhBlJWXEphRp164ZPvLSdrkvFDsUPVB3VwQ9lyMbJWCBTboo2skR3N4Fvw8Qrl8E9sv4mgEmWZRmDOiU25xQeQq697XXlIzLq+9scE2Ph6SK+iA8tjg4XJSDI+/IAA+jEQN4XJFG+wFi7xLzsVmBYDmsxUgXLcbnJUJum9iudys2IMT3pAg1/RD9B9tzoP4Esf6rwzJXY3FN+6Dqvf2GLtTP3LDK86rjOupn1NTXfO5MIrz6QjV448MAP6myhn1TBPAaJxptT0uKoTYUtkjpfFxWkahl7c99yMLidjlUy+U1mke59XwJbtCc/F8beyXCRnxcaUdZHSCweoDFc3Us3t+ooINWO/2CVo3HYUTLqEHmXB8soyCO+WVDXgGEJD/NIsAYWtI2LGRNVNkO5A9qhUt9JUa8OsAmFRFuuVYytqG3uGXO7+DBNASXqHx/JOCEZBmQo6qCxM8wCya+MX56/EqevjsTzZ88PIM0cV+5JSXdFwjXm63UudR2oNAMasBUb44B6jVjVvz0B3DRaw658U6fsrs8twr12/bEunm+dvT4c7P3fFWNJxrydRxmbyxSSCayQjbOKgRmfvRfPwSiKD+dHPBLlZ/tdcf5PbH6Ni2I5q05bG1ypHixov3GmBqj36LE3sj9PDp7syX31VD07ePrj7u7u3pMDOdltN7NPq2VC6a/UYBuEtRQHElzdiwsxRbkThcU7SkatViGqRANfuXc1rQPmKhY4VOzrVG8L+Rf6XNtEhLH8VSDBAboKFf+5mfzeT3qDx20B4tI7xDBUhcvKTipFFJVaFZc4gyTVvrLVULY6/mebj2lUUe3qoW6Gq9haQn6XYP8BZx1c4Nh6q6wjYwkYYp9trtXWsuPKAxc38s2EjpnacmauCNlR3/ZBkHe3K/ek8e40VsqY/dM8itCFz6nlhGEPwn/CN13r20wkOoI0p7YK34HuWLi30RXZaminjEnMEagB8gY/V8dzP7cH+erBWrm6KxspeA0nu+0A3yEqpXi86Dg4jTe37jDGpfFpkeZgw9vD/1mk8RMfVCAEI0TbNGjEpY/c0B2JTze9w1T/rPDjZ7wB8EJJo8whEJie4KnlDOtGvXpdF+lxPagVsQaBycOoy8Q2X0y1HiRm4G9r4BFfYUzW8aoNVCyNTrwxyXAN5XyA+iXifSca/R61h6vo4Cm7F7bQKlczeuuXFmiWS3pIvIUb8erN6BY//TbBqLfDv36wg7HYoDApOzeNHyu43TGVn0Rglnb9HsKxWiSO4z13I7G4ahjCdwOZ6qGGdDPOhjrZudrvtX/a4CzDasxsHRjLX3dA+lyKEweIpAxeqMoyJD9wPznA8tgrfubg0Cm0rwY1MvSTMU1IoNrjhErgfmThvDqXhMb/Sw3OF8HbiAW2CyfkG6b62o+xfWEcxRexBW6BxzUyIzW3FFMZqO2+UMPZsAF2JNzCv62S3CBFBoDc379Q7F5Vn5vehP565b3hm4/n7bORf3CDHm4SmNBjSA5nTDtqSIiCgmTKKEagBWVAg6wjz4YzRN4muqksmpNBW8PDeP8oWFqyRP9UPqrLQvlyy/4Ui8TW//z7v7d5rOlsqUINYTRlHhD98whUcwii6GnwRL0yFNXmlgqs0XRgcWZKgSd3Y0rZyk9W0O9qBMVlHRqcCfUM706A+4fMKuOBvASnHNMk5Ow8iZKZxikbUNxJxH1hbLHSDWwqoaEtpRI7dycJCIhgsuAMj3pXmq7DEcPc2OAsd5MxNNsqyPP7LmeEY5FxDGfDAjgcNuYbGl4LQOhACPfpyk+d5svlcijp62FiZjturd15Oz56+e7s5QDX3JbFrpIPqDu+ueC1q7g1TUnI8PFwj+/a2wywq+BDN7UaF9SrFqlx3a/wuX/pz8g46c7AFeykEaSblVvYbF4/uR+XcSWTQbVXMer6PRh/IjBlcyACQri5wfDug4lub/Ex/0QKWV5ABfgYdlcRqkT4a38sppMM7JuK34wpPVF/E8Q3/eWXO1Dx1eyaT7wCR8mjCRvRc+vUhWrbYu0PAHWi4j1QvKpi4lFsCgS1+5x1LWMMNNNp9SStqLLm7X96iZZeOjdQusBLcoHuQ6UXV8et6Q0ZBfxv5Y5mfcnfUM/BKf29eJ2/Wbug8B/8NlIKezf/CwOUvrM=
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: eJztPO1uGzmSr0L0nzgLSZadOJkRFotzYiejrJPobGeCm9hIqG5K4rjV3UOyLWsN/9snuUe7J7mqIvu7JUu2B4db7GAwI6vJqmJ9V7Fat14gtK9kYmQceQPvfCY1E1GQxDIyjIdhvNDMzATjwVxGzMRMCR7gAxZwwxmfKiHmIjKa8SjAlVLBkmupAZ5mgZjISARMcBVKoRiA4BGL1ZRHUnPE2fM6XpwIRX8MAyDBj6OJnJ5IbQ4z4LAm4YrPhRFKe4NvtzWqDwHm+HfhG7aQZsaGRzkJALHjSVzzRyrUEv6IAAz8WVmgxB+pVAKwT3ioRcfT/kzMuTe49cwyweXaKBlNvbu7Th33p3Q+hpPFE8DpxyrQyCR9JRM2iRVL+FRG9qDskEViCp+vBXCApRFyko9Dwa55mAoGqEPNxty/Qgg/+j96K0iPJxMtzEZkgxDFVChYC5LgaWi8Qb/jgSTlPJ3DZzqPAxvKuTR1lNWzfuQ3uJFFbWdWwqQqYiBLPLXoPZTAvX4Ll9/JEGQPImio3XjJAsUnZteP50kIGhIwbbhJ9QruhXIi/KUfCm8rMR8hWnHjz3g0FcxwNRUNZjkM+cON1arjiQjl8c0L5FQaHn5fgDIAjMu7u0uEoxOwJqFx536/j/8DKzFoGfCRJ0kofVKy3d81UntbwpQoNC8j7W7kXm5W9I00Yk4fAOPnCRmXI86aFBBnpAmF40HZJhtGmIuFIXlcRtZ36ET4cuJIRK3hTMOxQfOTVCWxBn7OOOwB1zAWuFUDCJCjiXsMrKaCloF/SiOwIaV5SD6nZRsqxV/mPFr+BTxOIK9lkIIAAIuK0+kM0FdAnpIO9y4iONJNN4pNV0ZdZNSYa5HLrhDmN8+RjW7JfjoqcaJDslExCFB9UWHl70+oIbArBoGhxoR8MUnDN1xLVFfwb7M4+Dz5QqC5j64CPoAfAX0y6CpwS66/oBlV4cqgTbVg+5yDonioZjccjQT+eHXw8vXe/v6++Ml/7b8Yj1/4+/5PL3/eb4jVu+t4yG1pFWsz6Hu9fq/fAHUOuuBAoRYYjDVV3QDRLWbSRxGBZxGwE+WKODTSUTBy2HrUKjoIA4SFdMPtq0JB8dwL5svpCcIhv1NsZTtzvkS9i8FrotbJCYtiu0pG13F4LYLnVWwk/HvR4arH4HO6Nag7sBF9D7YTADDLZBJA1br0DEM7oJnGICkI3WCBX2ciYj5EK4P+l9c8cIc4HHIjtGEWeWaSqbbWOJEAE1c5H28DXoeR+ZaTAZdl4PYA1CIQuNu5XGkweyAoFfwsFNcitNa7ynGNMnvbzLwja6UpaMeT29jr1/29VhuLVmhHO+gjx0niRe5O2jUJeeaWPJ0t/1q24ww+25HWjU9izByt8xdzQMksbNLQtN3q2rHPjEn0YHfXfdODKL+bKHnN/WV3xblHAgBFqBpouhBYStoOpCyrPkiwUUVpMSvrgB3EaRiAhRn8jvJgq8tOG9E6mJEgMjjQ76mSOpC+2Yqvx18alH8oA7rD7CJIAcryDNQ5VpuD/kXw0Mx8rkTTKTqQIBeCCVhQh04FZhOwBJgn4+CIL3VrltaK78WrgzoaSpdUBhSTQoCKBhwgZEA6FfFU8QQkcyrwNI9n3vscIiAuQAIuDQeFjPQktlHmUVjOLCwWZsAAPmiWCkZcmSUe+2zGCWiBZRzHoeDRKjRGgTNs1mEqgDwaYFob1w7q3Z2T2KEB2sepEWVBcaU4GsQGSV2LvHgOMsvfquFZo8UA2b4Jl2BUnJIxH8OTDxGpt61/LVPw9LnMQYufrZ4S6sTtHe+nJu1VT5uD71ABCDmw4ZEv2AUhuvCw9rvwQIUuyO1XAG1KxLsUAmpUQlpkuc0zF381SCTjEJGWkGlKs9xcZZ1Qa6ZRQMoTmAoq0CIxjdVy84OCN4KCpuVUbx2odkTaj5MtZIouv2noCINlakuyrCOiMrFuV1U1LnmitXa63jqxGWKr7RK0ddZWJQJytwAShvaceUUEeXH0de/jl6+/Ld9cjQ5O3r9U5/91+svgxeDtyeCn/iAr1htiAUzo8qE0o9aPJLWzdmZL0icgYn/wFs9GXkmwzxN2KqbAINtCGrxqTVfOCDlRQv9c1k3vSTzgBYWDrDrcONXPNty11pP3gqlZeAlaubzcmOtN7SMobIxgcheSp9/drPJmu5CKT3n4PR6Hcmrz+V1bwQC/4OM1dTYwl0A9hi+SFFb63w3XV3YzqAsQJPI1pcaIQ4IFcA1JVmBzMpwqEqrQcyR2cwMJ6kK59H44pz4SFOQRlD7AmQj99C75je86ThWEAfdXig2Q71qoa+mL4pi4wYZ3t95zf1XXk/YmkoPOPobcc1tMgQ5GeY4s2NFoeAieJokVafdURNidBRfIJ8AwbJ7AAs9RcJbO51wtNyqkEd2X05CBc4JYhbVkCZ3GasZi1ZB+W7BMGL/SG4KsG2wRaBkvoXhcskyGwuZK6O/Q08hpxE2qiDc33clVdx4HIkQ3kD9pOIjsCfWnUpAjpOJIo83B4MtqobyTb9DMVeZQGlCz25WpPjhk3DeHk0mQAMvJ0s/XVqtlIjfsR/FlGFMM06W9llnWcVnNrH05yre1fPsL17PaEyRMBG+WROsc2A6a9fSZ20Fb5vaZmJSzOuEaewvULAdV0DE40sPRML+50HQREKcGrxtkwHZGf3/egZAEzLR6ByoFMgIlAoFzyMeohXzhdZjsiR58U6iDcV4eS8GlMAyLiULImVhsKyOCqCBuIBZpeq44JkQ98uuO1Rtz5rbX6921mhCEVQivDmBOnibZdMgZQ0Hhk8FqOMmHs8+foNhTEJOzLgsoJRhRGGh22yL4AQPUHbZCJVqeWt1qeXCIURrccsujTJVaHn1YaKhfA6E6LNcyt8we8qsVrVWJUzEBDwAJtltirekceFz5orrsrsfOHEcqbMLSu8eGNsTlplT1gmMBAkN5L6HsA11C3rerxA7qxIygk/oZ7KPhihpJWbOh1NybqHhu+ypOzJCTUBvNoiFPvOAq0L2Gv9tMvcTyw2z83pef5Yd3vx2fnv/n2YefgTHr3WJGDJxpZtt+FniWFBQcK07k0ifrsgVIDkJIU3mwKGrVAdexqvuxzSv4YP/gYO/n/Bj7/f1mcnjIFiIMu1dRvIB8z9hrpsxX2MBo8wO6fNDYFP0VdCewfUw9YOdvjnqMrk7ncjqjlpG4SUD8cGy6kdRpgpEN/iwfxkHVuBdUIXNunNEFHRi5FsTbYrfbwCLhC60hQvbqDBo9jaMZYmAFPwMOrVB9XdhMrYUW2HaPU2iSdWGI1jfWdL5L+nBDaRu1laMCvksNZFZxabLOFSelOLXxafneeN9/EbwUB5NXbfreem5fLROTN5dQ+7Nz25tbvHASuQemCFI8hJVt8qkdJnOVj8jmDqu6xR3EzC0hFHf3BskU5ilWJEDwnE9Fp2S9kHXV6ctD/8b0BTIYXInl4B+vPl5N2lj9Rvg8pcgJERqLRvAS6hlGTguQDAQsot5xJc9jvTIHQ7BtWXLBLhiW9tswT9vIkOAUQDO4+GqKxmsizlnRsV1jipaZU8sLQ0w6CsqpQxDG8RVqb5rkHm2ZJbq2EGHAk7K/zFPMFqKiOOpuQphfoQv24RJwH0VXCNiK7SLIrBPXUXF3+B0GZbEMGQ8CyEs1JLNdx0vQk4gncGZj2ToGaHTPX/X0T8Rh5/qMzW+mQiUKB1Aa7S04SJmPNFFCgkBEcDwOFF5BmM0DKGgYKtXwCLyL1jRw0qrah1tUyOu6baeH787Zu+HxydGAnbnYZ2/BlQhtD2EmEzirWQiXDpSrjRJj7TgNXu4RqlKFlsVhkLgP3kq72AP/Ag5xzYFxqIxvXV1u77dh1SgGDuQDJxC3LkpHufCgNoVEWGB9bcSF12BUEZQf4aRC8q80BON0qRneq/kgOnjiRl1oTn+mCAsSuK9n5QDl5oF2Tt+9fX2wd0AXT0XRsvEBIF942e3vdfcOzvf6gxf9Qb//WzMrz+BmFuAo81MFwQ5bRSVjlTp6Zsjk87szJ04dM2me2UoDoQnVhcoqnmQp3qrM95Ft2yGoAHbStLXzeqBeQPgNxQQcQMijqyyatKQCtBtXW1qR6iIH2KYZawez1jbZbS+RUVnfTrYrA3GE5Ndc23PZZG34DNmFV2o1lSgoMuvL/DhtfH9AmfvqVUuZe8j0cg5JnqJLrDBrolGdm6dXmeGUMqwa73vsq6DSttDA31NtLL/CzM/YtCumlLzwOzvcNjKeI4fyZeBELFPYjvVDriHD80k75+Wdz7FzYR0M7qVJAXdLDPnF8569yXJDLhtrcNOjNKaDLEjyGJFYtI366HxmCIcarKqWh2yeihqLLYtt6Fkxm1zQOIXjk7SdikDxRdTBTFeC0lILgSTt+g55uk9+naeBBEJlKI3N/3HyDVQFSEcH4W7m72+0Vzpj62e7vg5HAxtknBOr+gzqnRdCyLicBXXsg4DuqqKwBUCsoJolqERxqivKRHaONl8hzbbYiyGoe7uORPpbawfsJNtHM4K5O6lg6LH6Mk22lE2zzHmEF8DSVQpsEaurCc3JosrVJwe0tUgcg4C4DGY9B30COrUVpdXVdv7ZmZZ8MhA7VJ4VNiqSbQLDxi+YOJzZzvCaO6bNroBTm4VYaNXZHKS3OX6z7aWvGzsAEWYX6I0G4nYXsmvjRLD+TPb+c7vZipbrF5xx1m6gIsNcRxNuPXywElEGahUqNx5zBHnTOOYqWNGc3xKrgwosdWBZqsJ2Euz1Gog0OkzkWfn+7P6rzvNyWeNmSD8jpNGwNisYxH5K5mIBjLM6C1Y+K2bYoSYgF4e1AbYhslFz2zlD/Tiji5ZHW4673/nXMJmWw/zbVv40W2mdI2gduj7Ghhle/ZfVBCV27CbTm6pReXqv+VXH3AMBBhgivtUwRyqeyE0CcRV04rYVAe5wONrrU1Rrv0Fqu67PQybU99m7JlChACjKi/JphKN8GGGTweH2KYai1XPfNEPr6EF1u9THmORh5K6/E1DknLU6TWdlj3BbEdAfraPQmNCCeqBnOVqCc5D+iYyuWtdB7oWZKKnjKWgV3oi3qMlm/mbNAGoJDU3VIJ7146jrB05XwHMfRdA6H7dC6z/yxI7XuL2lOZAnOHoLWEvpw0aDquQ8Ug/XjgZtaxV3jaGatsGlPCq28oWAYI4bR9kbKvaI9XGq/3+saarmn2Fo/9a27bQtF00WThuuueTsL11uW+EeXe9nr/m18TB/DaFY1RjRswUqrCiLu/x2XIU5rpzF9+xcI7+cmOwhhbHh4bAm1VXwznFx6a0+0gbGryH4u7eOctj7BxlwpPUhwJFofM+RurQRy147LKbJqb7HL++H/alGcvbyYYUbfQA443rkmgybhNq8vSEn9rbpGV425W2KOgrK3S2WT+LGPBxDBLsb0HE+3KppVbFaLKCaFWm2k7N5ePaZ7b8+eNV/DhwnM9Cpj12lSRqG6AFm1NpH7iDYl/Ytwyr0McfsKkmpfW3fxm3ZuLfV64llyxNKxeotVGt4evxcHoO8bA5MVU2o2N2mNzk34WR3LeBbHFKR6L9pObjzHLV3xSJ3mfMPETRYc7Dlm5v/WqzJbtapEQNmSmhqPLIlZqpoFh3K7sNE/l3gx0uskN4IroQ6BAbTN3hqPsX63Kv2z5Afczcn4tk3cROOm7xd+275LtYv3cJMqMZGotreLT8S89jR7Ll3l/KXkgJ41uWJ7Mmp4pHpyXj3et9rvjx8ZtDzT1eB0fZxC6TLgiEUjKw4M7YUUdx+4V5Hthz18veRD51KZpGnduUwGtJdKiouBlffva1+Xp5gwAD6owLnB7No2BwvFsaUkE/kTTbw8sPSyH6wnSg29mIXSldpLx8S7ovnHSZ6014N7IC5jX9dxqlCjnSBuL/9oG5NWQFuvTH99S6rzD98PW+ejTycuxJ2M4NEnoXkaKaKsUwEyzlIxkh+nDZ4uaGh6PA1cQ+nDTKrdvMbdKOO1mLHdv4jF2khEvm++KqqC8XihgXlm9jO//zzv5/bAYizhQikntm2TV5d169L8+6nnb0VqseGBjva2IoJJ12N0xVCTrMMyyyzO1j6gYKikKYrdveSOrMvqdvRnRjnoZI4YEb4sygO46nE+3gRAQB7g4SXMfSuJoVr9AbUjLP3GAQEVDCe27dMqcst6cUZEpgbMJqm7g6dpuAYxa7sPiTEAaoogrNhqwwOG9lZ7swKQOlACffp5YAqzxeLRY/T416sprtur949Gb49/nR23MU9d0UaV8gBbSdrQ2bWlRe0dHfce9Hbs2/lagPUleihZLXldzTqSlwKGP83v87hNN5AarKbhFxGpXc4rV/95n6zw7MN1bJnBQc2i7Gj8M27vcVk5IsK7+7wa/ujCeRvARlIL2i/ny6f/57f+Wil9Ao9ZfXnPsitefTa7TbY/9xf+lhDfP6DHw8kfNuf7VhDSpatP5CSh/2Mx1p6il/zeCBNK37ZYw3SfE2B8RL/UNJeH2O6kkVhVHC7C4NRUt7VyP7uyonL+2OMZ9wFuyLQX1Ggdx9KdxM8WpZg12O+JQH/W+o1V7f8Fb0ZhN6/5cvtk5Ub8ihpVyOHsD7+XwwcP5Q=
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: eJzdWNtuGzcQ/RViX5oAulmOm0AIgjpxEqhNXSN20IfYgKnd0S7jFbkhuZJVQW/9kn5av6Qz3PvFsR20L32xV7zMnLnPcOcFYHwtEiuU9GbeRSQMAxkkSkjLNPDAMB7HLOCWM26tFnKRWjAsgKWQEDAhGc93Qw2wAmlH3sBTCWhONOcBUvWVXIrwgzD2BE8eExmigucSrvkKLGjjzT7vWmA+SfE1BTY/YWrJuGRq8QV8i7cE7SbcRvgt8T7+IgjHBQJkOvA0fE2FBuRvdQoDz/gRrLg323l2m9AVQ9KE3n4/aDM+TVcL0MRVg6806sAqZm5EwpZKs4SHQjrhRuyYSQjxew0Md1JJGuOLGNiaxwh9ibozbMH9G6JwPbkeFehRML2t4Kvl0oBtoMa7pg82GgZC0HgWbcDT2HqzycBbCSlW6Qq/nTw52VishG2zbMr6K7+li0z2yazBployNCZJDaPvBXiAqK7orkmUNGDo9HQyoX/oGxZNRp88SWLhO82OvxhCt6tRTzQ5lRXZ7aDuSG5FWFi5D9T5b0vnTjmg0m+akp+UPp25NCHh6M8mAV8scyCGNAK33Lfxlm0ibpmgk3GMFCEghdwOpbJDIYcEacENlJqpVPU5M0gTASqkKZMIut458NDlVhz14+E3AlklMW3/ePTs+cF0OoUX/nP/cLE49Kf+i6PJwT1SYjB5+8LrHsrrtIs9WyTd2Agq8gMXIEIay6UP7NIxuvQoNi49dKBLj7g3CD0UxLsU05CsMRUyEGsRpDzuylz96kAkAAakERi0wm5rABZKxcDlXQhyozY5nVeUiFPQUDaxQi+CUOntwwU9w2SoZI9Ub3JS/YyMr5JH2JQSVYfDOdFghds6W7YZuezSE4pF6q0hKMPufi9H/EmqE2V6JNgTzxbN/VW1xLXmW0ehzMt9IKywmXqrU21kfqo1ioAn4I501jBHdtolxjx71jV8QAiV5fG8yEv30Lugw7U07PIZ42suYqooddrTo4I4Yf0e4gSaCpNBM2OQFHWi5HCIDLLF+2mftiAX1aKhjQkSjLg507AWKjW9YdckO8f4pugxTLgQ1vADqoMlOYUOCxefGZdTuLXfz0Hi7Q516iF6PXHfTmidulKFUREkqG+D1YOZ1PfBmCWmNirMEcak64R2RPRZVh+btBecWq4kJYB559Rz8eBRhbVepkBrpd+owMlO3yfNgvXt0K5u93lNqUuUbN9Dvid3VfnqdY/g+32P9j9JntpIafEHBB3VHD2y5/h/qWaO/DRWFmZArzFIHZuWjlx1xEToSiO2UMeJ+AXo84oS/2vgGvQxKtitkNQ8pNY9c/qqs8cdBBIp6v5D19i6dn3mjbNZYEwBMSwDYrxr9e/7/EDV4REuQt03KJzASuVC4blUx7gWWZuY2Xgc4N6QJ2IkQs1xOBFqvJ563Z7/3FJhCO8iY7LtHkpXlcbOyXEyexd6Kw3Hs4W8F89UXvX/x7nPFoWpie34bM5uYMvIs1E9ub+O2EVUDBp5l3PdoHPNMjZslRrLFkC5cyluMfFshI3wsIPErtkT7GDBEbAay41TQ8J9eDpgMApHLbIzll98uVWpJo0MEdwrnG3QeeoesvMW7te7ogP5+feLrmwuBeKwcQM4aHBjCngZpRwzzZkNEKzUoItWl+bdBa+MRDIdTXeo8aUqwh4beReOK5STwilNEqXtT6VJK5OI99VS0xeqw50QKy+xJ3//+ddTGhY4O99AIEyUFQG49SMusWXgMmDoaeWk4TxP+GQlhX0t6BGbW5bitIQ78XJoFJ4GEUqGm+gEdjvI77uB08c0RctYBQc0kotQUMnf4DQE1jEzKhYBS1TALPiRVLEKMTmhiSUSIJtT6duwGNYQu2pO6cIN8gv0CWxwiQi6oEJj0nFfYQISrtF3BnPiaQjTOJ+c3NuAK254LUA4hHPFpUTZPOovfOyeXUIsogCdDp1wOpp0dL7ZbEbcbY+UDsf5XTP+MH/z9vT87ZDu7Ksur7IDxU6g/JTyShFdlEYye00n02ejw9GB6x+VsYiuhucj+lirAzZtB65Vk3/t9SR3YIuNyDiJcSYleE4fuzyPfs7fVAhNI5Piwqz7FtJOppizIpSW6Ox21AV+0vF+T8vZI4FLscKQwYL+yacu9n/7XNKrjBvKrdWribtOI47L6w8G/ti3j29AKTroCskV/dAuOB+pzycf87bjKbvzCawXSlFq5LaOpIDYdgs3ROVplABmpygfJ3VJOh3Svl7c37+llM7zfF/VuhtX6/KP2ltME1u77GUQ6C8ZsvfKSwporD6vyuPZzp0XykKRnSZNXWGf8w+B4Ead
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: eJzdWN1u47gVfhVCN50BHNvJJikaLBabmWQW7s5mgyaDXswEMC3RFtcSqSWpOK7huz5JH61P0u+Q+rOtbCYDtBe9SST5/PGc7/xxEyXCxkYWTmoVXUT3qbRMqKTQUjmG59KKhDnNMmkd41nGpErko0xKnlk8M5cKps2CK2k5yWCJmEsFnuq3WCsrIGpWyiyRasFmmY6Xw2gQ6UIYzzJJoBh0c7n4CC2TVgGoCm54LpwwNrr4vNmz9qbMZ8IwPWdGxNokliy1S1mwuTas4AupvIYhu2RKLPD8SNayUhnBEz7LBHvkWSnYHCezbMbjJUmYjqdkoCQVv5fCrPGiYAVe9XxuhcO7Eb+X0giYDl4rBpGNU5Hz6GITuXVBpHCgWAgDWriEl5mLLsaDKJdK5mWO5+12sKnFZjKXbl/l7ll/4U/EyFTfmY1wpVEMHqVTi+G3GngcrNrV/ElJmMQmV6SUK6Znv4n4wNrqJOIJsVI8a6OI8H6NNdYZwCPabh+I2haEG0u/n4zH9A8AcQASPfKiyGTsIzv6zZKNm468whCynAzcHbj6Vydy/4CA/zr3kKr0N6dy0mX0oT3BQSzuUrDrVbZmuU4EkAOvtORslco4ZTlfIy5zYYSKBbM6F8gJ6zi9ITnAUvuK2bWFXeyNEQskQMiK6uOAzUsV0wfQTa7wqkuV8OYDEy5+C3zvGNDoQcAcZbQ3k9JZaUd4mQmWQxNfCsVW0qWMIyd8lJEwpeHdNB+ySagEBXFSTlfm6pUC3vAtEbFMcKhKWcAlgRGghm6EixIfhLxHPByRjJCT4ObMghBJ2TmK0SsWw1eQ4pNbPArir8sKXxghcjxZwvzTEc53JNURHMRn3IoGbnugSA6BN4hQM3IOgEV4Fk88LzwMzk/PTo/5iTgXfz47/8t4PD4+PYuT8/MDUNzDM+VequweZBhtB22CvMIGFGHzY/U6jHV+oPtvDc7Iy3BCish0kTLaQ1GAKIKVyaUAjm8nk13j7r1hX2sgUk8epsl1jW/4g+QwWwApcykMFeQgcsg+UPBrwH4Jor5EVKa/RHtg/xIN2Xu4FfD1fQlplHHoYFSEEFvvYEBRIYfXt0bD9cK8xtF9weaz45OeYMN3sS6zhIyBSR9+HqDHOd94FDC7EizRPt1SjqbDmzQAMGoLWVGZaJFjV+/e+ZLhyXNtBKtqZoXura/MLxcrON1wu1NyP4fiPGjCVKRaiehhPy1CCT/01V7TBVUoLKKTxt7zPO939q6A92i+jlxCsKYYLsU6zjRfUilgls5PsqcymTJu8Z/ETj08vf0vKrgmMniUWMJRX2S59WREX9r0RjugNDSYe40a+TL/lXiUPvuoovY6J/EUz6VVvzQQvfn17m2PQPhC0RTxOYLPjJbUY6W20QM0EdKeg/2+HprVrBceuIDNPvPRlSG4EsaN4Wvvq2bA6qg6gOZtS7UPuLg0qFoOFOKZuWQHN4HaTzjVGNRN3mOyUDsUr7rHvyDvnog785SfDRh/BHhoNOzKPjmrhZOt3yKcjKYJk8oWmns98DUavoOC8PFl2Td7Jtdj3443xhCYcntrgCVddk2eaZ0Jrg7EUg0B6GGm7+RoKH+CO1CkgoQDFb61Bi03aBzfrkGB+0C6M6XYUtHbA5b/dCi2XkloT4GLbRnHwtp5mWU0nKYY9/0KsSHu0zBR7gqZceonRUmWVCtHD+Pxq0bRbgkWxmjzHnMYHZKerzrqH/ZPuZ8pLXcfPBqn4WTbHvE9haDtee96Dr7d9rj5k+KlS7WR/xDJgWvOXjml/3+5ZqLqSV4YDKjMq9nzEZisQMVD4/d7x2Uhfxb0+ECN/Z3gRphLONh/oVPzBe283T0EX2FEqmlhXvg1tODEEI3C+jySO7tzMKZvcb4Sua5sBV1p0FSj1LnCXoxGCX474oUcyoXhyg2lHj2eRIdr4Z2jwr54TowNP/dIemgdcUd4CGGs3dHEg4cP1ZoZPNnumZcVFOvGsmvb5e2EpgpGgKVZK66uAWhGDxt/1eSmO3KmLKhheWkdDXaofXP5hHril6RpsJFN2RsMdmFKwbAlM++Ggsfi7YCJIWbaXbEXrGL8fq1LQx45gnE/TP242g38Jpr5tw/1cPrXv98fns1XtmrUKLi1tXlBUmUzzVU7RrDGgz4JfZn2DFGTYBS6iHAq1VzX2cxjn83V6BXZsii0cT82IW1DIn9qP+1ioSU+yJyGib359z//9ZZWEs7uViKRNmW0xmFLjlOuFsJPh0BaM5p55NGcVI/RflPFUGnxSzY/shrUQi5UM3APKn5/8xOj+tBn5MoAOhO5kNSyV1jthQujqM4wDhU6YU7EqdKZXqDmIMQKAijm1LpWLMNOmvluTFXAX2vNgAnM9yQEENQIJpFjc0NJ9HuOD5g/Hnb+MvPn8fdpnPmeBbYE5pCdOVfYs2m9RTkVyop2VEfScASTnQzHBz5frVZD7n8earMYVbx29HHy/vrm7vqIeLbtlNbGgXIn0XFJe0edXVRGQrxOxienw++Gx37+09bBuo49H3tuCfcB3GkS/8vrxgrjDrPGqMg4isq2ctmmqqKfq0tIX3Ja81GuUhyUft9saID7ZLLtlj6Hqy9fXWEOYtVebz174v/ulWXvIZdUVtubS89Oi68v6V9t+GvvH//AlHr4/UZLnr2P/AOVz1xLthY80IvxlSG05LrjUHiDDCq8Rdfugwln223QP11T7eZVYW+b2tI3teqhcwHJ1boje7+/BRPob+caYJfle8pctJkfGvLwy7MMTUcI1OSvB8wp/wFzKl12
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: eJzlWd1y2zYWfhUMb2p3JFmSf5J6Op114yR1myYeO9nObOyZQCQkISYBFgAtqx7d7ZPso+2T7HcAUqREJrGb7c3ujU2RwDkH5+c7P7iPEmFjI3MntYqOo7dzaZlQSa6lcswInljG05Ql3HGW61TGS7y9lRbLLUvEVCqRMKmYmwsW453Atkkh00SqGZukOr4ZRL1I58JwYnGWgAnWTeXslbTu3FO8qAhiZc4Nz4QTxkbH7++3pHun5O+FYGenTE8ZV0xPPorYYZekrzl3czwr7KdfnjT49SIjfi+kEWDtTCF6kY3nIuPR8X3kljmttc5A3Gi16m1zfF1kE2GInRGxNtCG08zeyJxNtWE5n0nlzzVgJ0yJGZ5vBcOXQpHu+CQV7JankHkKLVo24fENUfgw/DCoxMaJzLKWW0+nVrgNqbHXdokNE4mZMFgLQ/AiddHxsBdlUsmsyPDsz1OSTWUm3TbLzbP+yu9oI1NdZzbCFUYx2JFOLQZ/VsARpLqmvTYnb7G0ejwc0j+4hYP70CPPc1jPa3bvoyXp7hvUc0P+5GTYXRuhwXntGU66lF6c16t6WwTiwhjwxQrxCdmbWnoWVnstlKrCGnHHs5wYjVbgqR1Pz5zI7APovaXFDZ1L2sf4LZcpuU+T9viwIk6y/hniJDR5oUXQasUqp1hz2AeD8PLLtF9viVy5xoY2hiA45/acMEMXTZEnWqeCqxbZM5WQ5SGmnBKqGPEN1MHykkKLhfe9wOW1uHN/noPC7hZ1AowV4qiEk896WFixze2kgs2ZvhWGQJOglKuEneLhZGaEyMifSgwFbKRZBW9mxpW03mvxkWORxYIpJE4oJrllV5EnR6FjdJoKcxWxnZen5xe7noVeqCqSaZeKCZXXPC1F8V1fadeXqk+EyDPW4VzH9/uAIr2oMGl0vR0/MmlDaS8CPmYc5oia6oyODg+ejMbjsXgaP4n3J5P9eBw/eTIctdQWrSpEfCjp0wAxzVTV9llQJHWQpssl4AO72E34+AKr0WA4GLaI/z2Q2aTPdqRjMYw5hXn0wn+xIgNLFmjvkgSk1wdznzuX2+O9vfLNINbZXm7kLY+X/U+c+1yAkCI3e3fxisGRFnMZzyEMHAqiLNntpuzBl73cE++TSY/ZuS7ShMFb6B2n0wQ3jOdcAQvJvZmTMBkO9LEw0iLM3KP0+vxdS/Kfm4RWlL+SAlSWlwg+bR5O+ifElZvH3IguPPAkYRdPE1zIhy4EZSMsgfKkTk75shtxO/ntHx1us6FwpzQaiBJcgiqFfUKUwXQm9MzwHJa5EHSar1feyzVFMK5JgpfFQQF1r3S8nTkfz+Uy0GJpRYyy1Fya5Jwbt6RjX865J9qFzZ1sQp3WKk1NAoAGzRDjtqTq8XldlHpE2sq9LayuKs4OtP52JoCZMv52XeeyTCciRTDkKIGQNUIIG8lTSXm0LFtsAG14ka9TkFIshEP9Z/RiwHxdLf1exWzh5aHYGe2y2Cxzt7aTlTOUKeDj8XsMGC8S6UBpcKWu1ImVCWpJozMvxVVkizgW1mrC/VinRaZ6jNeSlzE7CbU59lLmoKJcJA/Hfkk1dDjV65AGgj59bR0eyci0CFr5A2r5QySXiufg7sq34eVP3M69FTJ4I0z9388lR0cduaSyNhoH7/v1UR7MK2nm6ja8lsVJuiSTePKwx6RwvktwIp4rVBwpAamlvqlhFuAoTHLVEOrKc1ZUwb9v8a3xvfnhwtfp0fWqYZqvUuPTg+/G7WKSEsMvVYrQpQ9TWbJAJVJHRLTacIsHC3I/GAxWnVybvOQ2K4oYkfwmHZTq3rSP/wWoKR3+UyWi51kp1R80FVNkwJSrGwLvDpdHckWQw7JxkXIKXbYZAYOaXsaXhAYW0QYzwn3gElPpXUKqgT9dR0h9pUarcAATj6M7hGI42M+Xb17v0gNnlHDR0qILW/rX7BlX2vswhPHp65L8VdBqqvvPnr99wS5ePGNPnzw9HDB25jwscqnC+IAcZipFmtjKfYK/M3EXi9xBBwHFzqjO2FBW83elAEBhpZoGrjxYK3w0Gcf7yYE4nB597rmlOGJD8nfZfOfyp5P+yBdzNbw9WKTxcHzQH476o8O3o+Hx/vB4OPxHOxIquiSD97EK58nH5uiZkbmSASm/BpizyzfsKUCRvXv7jMwt1iUaLxAxhg7x45L8/VYmBdpWHzrtaAhfCUF721OTTVJvqKN6FP4cHB6M+FgciSeHR98Nh8PRwSGfDNv19UXZwwjf+yjGkwwBWFgqOylK0QEimQqcMQmVbaUe7yxVogyi3fWnN32f1zergW2RtxQx3SRMYKQ0EirqX+PdOiXQcOsFvdB4kcASFcJaCJIIHW0iws/H+e/DvDfebzsQKAjTRw0jLZUsDLWUnHIgq68o1i12GPv0EMK5hC79x61g25T/sipaHn6IpqhAqa+Ule0sBEu0+saxG4UuS5Yt2NYqn6d8uqAZHWqf3VA8liJzY/gyarwo60a/pqOYb81DU5I1qcw8LdKUUvUc7ZOfZ94TnYMw7NokN+EE+HlBA4hy/tmxcfSoKVmzhBPGaPMM7k42oOfTBvvr7fNuF2X17q7+Z21TnGzVQb7DJWo3+LHj4KtVh8LfqRpkOlRz8H+sGnSLujCARWrNp7pQbQUdPnLC+r+loDPwMwrZCyBGQwrPZktHvp6ICyPd0l88nOTyF0GP1zRE/1FwI8wJPNC/oVPzGd1QBCAoR394DSnmmu44Zn6G768kjqO9cOOxFwBj7766m1jtmcbVR5Cu697jVGS6FL4cwtVToATf+jyXA4kWUrmB1Hu346h9k3HpaAI++xQZGz53ULquNROKPm/XSj9rA/HworxhCKqtbzVOyuCtJvBbXff5GbsRS0YhTuORuLxTodo/XJ+UVeOHDTofWGDDssL6oRTwfirvgMALdANY7EViH9gOIkN4As5wmXo15DwWuz0mBrPBFtljVm78fom4Io30IdwPH3w93vSE+2jif72oMtzPv71tn83nAlQANyjYcm5tJV6gVMpMrcSGEGytQR+VPu/7DXWRQqbz2Uqqqa7CGxnSh12Gc1LYFHmujfvb2qS1SeTL+tWmL9SLW6G03sR2/v3Pf+1SAcTZ5UIkEqWx7yZQ0Yd5IM0v4GlyWprTe56MyUr6lkYRvlJF+UYNXTrtWxogCmRnho9wArfslfv9NVpM5QZeo13r+Q5lJuluY0ENtPPMLKIqQVJOQsetUz0DCMHECgTI5jTjX6B/uxWpv7YgWPA3kxP4hFt6InBBnYWuLdYAGsmp4PQGS8IAb+a7Okr3sBlnPsuHKY2XM+NK4WwRXaTEQlkPfFUUwOnghGM/PN7U+WKxGHD/eaDNbK/ca/denT17/vryeZ/2rOoBVm0Hip1ExwXNAaroWg+0fWMx2B+MfMGmrYN0DXnoCrb7anfbjRu546+6Iy692ok7t5enaB0bg/GAo+/Lm+PmHOR44563kh6YNcdpacv9PQ223pl0taLX4erTQ6y0ZLCkewTQPPBfewncee4bwtb6Lthvj/ytyGMEf+yN7mdEqa4Ka0mu6YfxwflIfe5clOXFLvvkjX6nKFWqUcumJJWIa09Y0SCsxE+SLHwmIM6bR2iVQKtmAn/5nLCcl0BfJ7kbn+TKB6LeKdR2vgsi0F+yYOeW7ymSkXZ+WC8PXz65YZ0hwmpS0TUKmf8AcFSusQ==
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: eJzdWNty2zYQ/RUMX5rMyJIs59LxZDJ14jR16no8ttM+JJ4xREIkYgpgAFCy6tFbv6Sf1i/pWYAUKUpO7LR96YtNkcDZxV7O7uI2SoSNjSyc1Crajy4yaZlQSaGlcswInljG85wl3HFW6FzGUliWiIlUImFSMZcJFmtlBZaPS5knUqVsnOv4uh/1Il0Iwwn6KAE41k1keiytOyWkBRYU3PCpcMLYaP/DbUeZA8X0+JOIHZtLl7GjQyg0kzbA9SJJaz6XwhCQAgx+ri0w4nMpjYDoCc+t6EU2zsSUR/u3kVsUtNw6A32j5bLXlX1STsfCMD2BzFgbmMFpZq9lwSbasIKnUvmD9dkBUyLF80wwfCkVGY2Pc8FmPC8Fg+jcsjGPrwnhanjVv0N1PZlY4e6lNnwjUmGwFp7gZe6i/WEvmkolp+UUz/48FWwup9J1Ra6f9Rd+QxuZ2nZmI1xpFIMj6dSi/60K7kKrS9prCwoXS6tHwyH9Q1w4xA898qJAZHjLDj5Z0u62hV4YCignw+7GCS3JIWAg2EmX04vTZlWvAxCXxkAuVog7dG9b6XVY7a1QmQprxA2fFiRodwmZ2vH8yImpvQfeBS1u2VzSPsZnXOYUPm3s0dManHT9FnBSmqLQImu1YnVQrCTsQUB4+XXsk47KdWisWWMIwIzbU0pIXbZVHmudC642YI9UQp6HmnJCtGLEdzAHKyqEDRE+9oKUE3Hjvl2Cwu4NdGdKsUQeRTXpEb7suHYz2Gpe6xBZoM4FS/VMGGUDnXKVsEM8HKRGiCmFVsWnYJB8SvblIECTciWtD2B85FhksWAC5RNKT27Zx8jDURYZnefCfIzYo7eHp2ePvQg9V3VS0y4VE0OvZFpK6Jsdpd2OVDsEREGyyuwm1T8EQulFpcmjy24qyWSTVXsRqHLK4Zmobdno2dMnz3dHo5H4Pn4e743He/Eofv58uLthtmhZk+N9oQ8D27TK1aYzToBI5iBLV0sgB36x60zyFVG7/WF/uAH+a4BZx2ePpGMxnDmBe/Tcf7FiCpEsYD8mDciu95aeOVfY/cGgetOP9XRQGDnj8WLnjnOfCgApCrP3Z8cMgTTPZJxBGQQUVFmw2bruIZa93mMfk0mP2UyXecIQLfSO02lCGMYZV6BFCm/mJFyGA30qjbTIOPcgu755v6H5uzbQkkpZUgJlcY7k0+b+0D8hr1wWcyO2UYOHhF88JqRQDJ0JKkxYAuNJnRzyxXby3Spv79nTrhhKd6qoAZSYE6iU9gkhQ2gqdGp4Ac+cCTrNPzfe2xUiBDeQkGVxULDesY67RfThUs4DFstrMCpYmTTJKTduQcc+z7gH3UbTW8UQA2+UNYIEVwMz5LitUD1VV7jcGL6IWi8qmvZrusScoxuliK+iPSy1bNXEUbfne9yq+qNzoSRB4YhBi+RHECVxaIYdvo29JTFPQmezLm3MyddFSdWmanu3bNx9UEvUJmhhjDavdeILGT0ftsRfds3RpfBm97YIX7kFJ1tugd8SPE3AvNpy8OVyiz/eK166TBv5u0g2TPP0gd3i/8s0R5BnFJo6KwyxrBfTsREltUCkSrfw49RBIX8W9HhJA8ErAeYzBzCwf0On5inNXYGWqt4Fr6FFpmlgS/08UnDaEQ3C+DZYNUQkjFTZNrodiqmuNK1ahqZmJfi2wwvZlyAm5fpSD2ajaHMEO3fUuqd3wdjweQvSZWOGc4qG4MTaGCtv8PCiGo2CHZtx7KAKxHp06BDH6RG7FgtG4UokEFfD4EVWz31VFb1aw7liQQybotpQCUV3O5E3qKF+wr0KOrIr9gglVngAZzAQeDMUPBaPe0z0034Hdp9VG18sdGnIIjtQ7iVGTURE2+230dj/+rEm3He/XWyeLY5Bcqjq1wIliltbqxeQKp2paq0pwVYW9CnoGd5viFbpRa7zxCzVRNe5zGOfy0haSe61ZVFo435YubRxiXzbvFqPhWbxRt6sNrFHf/3x52Nqnzk7R9sibRZqiLipuhfqlhFpclK500eejMlLeiZxtj47cqxECcCXfLJjqd0RMlVM+krgFr1qvy8drQLRg8xEppKGsjnaJuG8MItUQjlDC+BEnCmd6xSJBRcrAJDPaTiZs1zMRO7nLeIAf6cyRkygBhIIQlDDmbQcXSAIkSuo7B2WhHYjLXN/Hks+42xS5jlFbgJ1SE90hZgQqIYhsYWynuXqLEDQIQhHvtVdt/l8Pu9z/7mPIWVQ7bWD46PXb07O3+zQnmUzGjV+oNxJdFzS+FFn16r9jkbD0ZP+Xn838rOXddCupQ9dHm1eSHVDuFUk/u0brSqSHWbGQZFzqVqteyDKD9U9V9SaHcFIGc5CH29vacB6b/Llkl6HGxlPoJjy4I7mVuXOI33lXmyritdEfevXY56nwpj1EOn/7c3YF5RfXZB9o+IPveb6gir1/UmjySX9MD7xQ72tCwq5NmwiXi3auzbal2W7+L59Q9TMK95uata1r1nVA6HXn9Sihd0tX0EF+ktG27rlBSUmqsjL1fLw5c4NK8IPq8lAl2hC/gbv/LoM
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: eJztGtty3Lb1VzB8aZLZm1ay46iZTFXJTdXIl6nkuI3j0WJJ7C4iEmAAcleqZt/6Jf20fknPOQBJcMmNZKftQ8Z+sLjkwcG534D7KBG5ETEvRBIdL3hqxQBe2djIvJBaRcfR1UpaJlSSa6kKlkpbWMbTlBUrwTZivtL6xjK9oN/aLLmSluPSEXvO4xWThciYVPQZF8Naq9lSroWld0bYMi0qBCkHiJzfpZonLBEpgJk7VuhwtxG7gh9WGPjGEg14lHaE4QoBnNR0jdgbK2jtTC8WVhQzxlXCZqnMJDz/XCL2nBuewTJjcaOcL3GF0eVyVRM9+lH9qHBXJTYC9vH4Wawz2H4hDYCEVBmRpzyGT1w1OxcrXjCQZSossg6fJkQNr+mpICYgSAe2kYWjIhELjnJa87QURE4j3ZVOEydMK2IjCnYj7iqBVpSCBuJUcMMKcYvsRINI58KQps5B9VGs1UIuL4DZt154ANKIJjp+d79jGC/LbA68wkZgQNokJD57I3O2APJBjlJ5QzgBuS3heY0WwkplBE/4PBWOGwZml1o25/ENYphNZiPYWuIWpCD4oYAK+OkkCb+N+LmUJjBZG69ExqPj+6i4yxEUbFUshYnQmkly0fFkEGVSyazM4Hm7HdxXaEn6u1u2eX3Bb3EhU308g8hLoxiIk6xn9LEEHjiq2ju/ogeegikrCcQxmQhVyIV0ZJDWwYrm+rblfUhXCbaPqijQg5EigWb6diUUu9MlGAsYH31bgT6EGXgTMmsZg1+WytlUbSaVF4OloBFVu6MQk14aBpVBDxhfcqnAccgkQd3CL4fPvdSjX6BXh+syeGwt3o03F4Kvnbc7hpgui0oOOwhqh67ZhRU2lAbTKr1jm0pYvAQMIHeMlM4rOZuDPwEgj2PyaH0jVCDenhWKnbw+R+9si7rgNz4Y9spiYXRGX/1iEo5cKm1Ei2KIQBrV5vcZImiMkRq45nsUNJdkA4Lw+jDbSwQxMHv95oqN19OxCxZjnoBDjXkuYfX4Hv5+J+7Ok+3YYxgChhlD/QF9JPHZ34aX5dyp4DyZYaxzwa3KQWRNTrshX4Gw0PqkKgV5Hoo+BwsrgBPQNaJ3W78yS8S/gc2ZXDTmPtfAhkNrGxvoYzgrwezELcTDgXuei1SrJe4K2EzXXD0QMpPqO5FA2FMQ626U3qjAaQeonrYP9yunzgboBxXSgcsYLQwE56hzQmGJXCyEAYAdKsEWMrA158X4a8Fl6lT756ur1+xoMqlDrxNSE3vbon1UiLOFkWoZbQeRuOVZnuK7p8+efSUO+FH8ZD5dHE4mkwN+mHx5MIm27xGlzbWywiKS6WSCfyjaqAIfeZ6n6E7Ay/gni9HxPtg0NxipCulWN+mHVqbpqwWlME+anv8kYoz5hSyIrtcN/GAHVVwalCVAiD3xO4zXpw7a1REuXUSBAA5AGoUueHoOmds+At8VAgd5BzM+1BVr0Bym0BD39EmFHGn9GORINGZiC54IBlMlxnqHQ9jAvXwY98sdkqv02JLGBBCuuH1txFrqMiR5rjXUK6qD9lwlFFLJr8GQjfgdiIPlHkNnCzJOt8tLyFofv4PCnLeLvTCl2G7RdneLZhFUQCzhBfep2BeU6BVVlYo0dZc3tbXyhTIlcNBMVWTIyoQa826c8l0k0Uu191ZfU78xKfzwPnWFcgC/Lee491wkz9fwFuu+BEIGGBcudCUlBHZ8huLu0qbfCwORJ668pZBQBBcgkAjEsM+/fFHZEfZJUEtjTil9rdGb4MM8wNMNv7MU1aE9oTYBomGa1MnDkTCAGE45YmbDzDDqeDlIqxO5dondW4FVnUnUDnX8YDGND5Mj8WTxlH85fxZ/lUzEAareqeXjN+wmCsgytk0LbBPy/Ct260tPbW04NZDcvRawekKL57WCu3mqwuuyWwbbYq9QwUNJIKhNJFxIhyD7dCHFIsfMxqBDYjUw8IcZ/euFo6beImyVPKa2MldFkdvj8di/GUHnNyb3HMul4ZCftm23epCGUwfMEGq3WQspUNiuvOvmvkHr1e1ws9kMQd7ZsDSpULFOwHvfb3u8+3h/EuyLBJ24REogsq0TYkh5JdABFp2HbAltdG5Rqb7zQk4PKnYPGTcGnZhKJ+xiwSZagM1ebXMzYgFFPbXXDUirYAonDt5eiJg2nnp6YESmoXdISidS35nabpiIsT5RxQuuIAijxVaBrRErMdWnb1wIBVi1MpQkkWUbC4+h6HDNB9Z6kJDWMikhVbu5iTa1BDw9A3zH7Q05lpuCDIC7jaJBCjbdeYJsgUykoXTUSiC/bKqXtVk4+gKzJEwO9wgUV0gaJA1a72OuYpG6bOLJHUHG0pvWG0w5nZfQQ+lrcZtL15IjUsdcd7OK2Z4vbkVIRntF8+U9NOCQ/JYSyqK31KU8Vr1nblHVn7ZU+5yy06vzs6PvT/0X0h2FS7LK3/sZVS6UTEZfzLz5gX+4Yp0ioH9HVg5W4fCdo3JfwTr89ZpRMeZTqBIicYbFZp4n3/w2GzRNDW2TYuN7dn52qrMMSipd6FindZ9U0QcFAaUIniImb7ILjdojNNLaEvBYSCTU3jS0Qi5ecbX03lzhW9G+D6J1YIS2vR5qP7QWl5a+GK0Pd1cjBbWIKhqO2cyXVNe4ejZofvsolvhpYYj/msc3+AEnf01nvqaKyBM36FkFuyfgWo9GGPJKw7pf76pd5WnsEol5Nw3s/VzJohekebwmpT8IRcw+DIQV28NwftrbC4bkoFsDkJJ7YGhi0yG8a43Bll6Pj4Te4fYB2F2mW2YdmipY+ANQldL2Q3ZN8JGwXgII7aIlhNIX3NyIgkbej46X2BFlzbrHJcNwagayoyatTm7YpFGjBakkTrUtIXjypREu2bp57X8v6wW0j/D3dbPrdb3rtdsVJeUyi2+rHm5CaYw4w/ZyNuitsKBs8TKrjklcxV+3aw8z2BwW1HVcJVyXnzROieIy9ZUDztfOv8Vqd3gpl9DaAq+zely6YAJPJGpq9vUHbubfOo/AX66Fa7h0k6ABs5oSERSq1XERfYBih6Z64TfgxMmgp039CIl3ikSK8q4Tubq4ZDFWhQtXLvqKtjq5ggaDKGla44d7kqtThuD7DD0JrYDK69nf4d/wxYvh2dnVanWcZcfW/jDDpivjxZ4616W+UBE0vfQe1G55ppPp0+Hk2XDy1dXB5Pjg4Phg+kO0pSOKndbZXnBbnHnFX5Y0D+8fanzsaZ83GusV5CczDkG9UGI5jMSDQrifa9cHl1R8Q8sJYaxEuMRn2+lkgjtOJ8+ohp5On+7sSOeV7W39KV8Gho9uuIdyVkJkTwFg05IrYhrsGiNGh9bspleknflKd/DUtM/10WEjc+yCemU+6k5q3sLyFg0kODLqMK7vEr4JDw/rkWqXcAqH7YOu72CNH82D8SDA0eTgg0bAISHCGG1OQc0oe3w+C3brGVS1TbpZ3TforHV5NMEBZgd9j7M3bvVHkLtUeVk0B88ojq5A3ig8QtJG/oOqgrZonnzgdPy3JZpz2M8oaLe8J9I2OzJyybA0srij0egJHU/B43uMYH+ks7sTEDC9Qa75Ek+560klvAIKVhoPx5d06pxzhI6q06/A1B0ZfYfkZyLTnkqAK3E6Vc+SEvg25LkcuRHSSOrxehp1j4DB9cCTlvvQWPe5B9P7RgSXaAlOgZUgmgrNvdhz8HPijbAa9+7Em+pMsjntrIeDPsG4mDlr4anLhurUDGrMhbzFqxt00OhoZDP2GWQtV3wUhsuUxJBDzfX5gInRcrSD9pj5hV/jGR1KBE9Bv5lRMg5Vfh+5w9s/UbIEPv7y9qrLW3CwCxZpbUWew+RpxlTcIoLVEiT3ozBPC6LatVB1FDqlWujKj3lMfgwOK1MaxuW5NsUfapU2KpHfNq/attAAd3ymXsQ++/c///U5pTZ2uRFQlK5c3Vx1xpQ810H1VNcREAnWko5kz/0Mw4p0MbQaoAWUhH52XNwN/Hq65dF0OXgTgCXtUQluZnUqE5ZryNkiXimd6qXEIaJQgAB1jscvG5ZCkZhSIkP/p4sJc7CJwh2J47AIlIngVAZI7P+cwog9I5ZYygI/1h2JL8o0RctNgBykM+NKAW8RnnHFAopMVEflBWB0YITT0aQj881mM+L0eaTNcuzX2vHF+enzl5fPh7hm2+TXRg/oO4mOy6xqrgA1hhGnLyi/jkaHIzouyLUtgLqAngt3lSplQRRK2nG2zg2frnD9Vq9w+XCCL8ZALsTvrbfOe5+t3vmLXVFw3AhpYQUGhR/v7/Gw941Jt1t87S4/URarW9W+S4Ghcf1vr4H1cniD6au5DUbL4YVLnY8m/EPvdP0CKdVBeUPJe/xhKP65kqPKqx8m3E+3vz7d/vp0++vT7a//4+2vXwhznTtgrcjrYE5IKcG3Tl+6DTurb59j3c19Ud40JDfUkPiH4OIWV3cB7t3exJGA/yNBvUu+Rj8CS/2mBndf9i6oq3kHjfLAce5/ALvIyxM=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztPNly28aWv9LFF0spklosyQ7r1q2hJdmm48QaLXFNLFfcBJpkRyCAdAOiGZXe7pfMp82XzFkaOyiTkTI1c+emUglFok+fPvvWuOv4ynpGx4mOws6gcznTVqjQjyMdJkIGQbSwIpkpIf25DkUSiVutFvRNIBNlE+HLRAo5NUrNFSzx1USHyr8OlTSBVkbAKhmKyExlqK3EbfpihKBtJIxKUhPaMjijbrWFh0SYzsfK9K/DTrcTxcrQ0pEPOHpRONHTcyX9YbYtPBNLI+cqUcZ2Bp/uase6CvXvqRKjExFNCJ3xb8rDVRp/jWUyg88hrIe/8EA5YNiw2zHq91QbBXsnJlXdjvVmai47g7tOsoxxiU2MDqed+/vP+LCNo9Aqi7/v7+7i/wDjBLGEjzKOA+3RYXZ+s4jcXQlebPCoiebVFUxocRB8mNDx3Mb5ORKdBPjFSWVJt0aGYVjiFCIltaO+jZWnJw4xIpKwcKRAiTg1cWQVPCVhDdBurHCpBRDKB4HoCzEUlW0FiFAa6ltghQyA2n7bMjFeiu/mMlx+BxLi61vtpyASsIuJ0ukMtq+APFdeZHwWhq+9MEp6OuwhecbSwrEnsFSV+fSp49BGweBPJyVKdIkjJgoCZa5MUPn7J5QCWBUBm5bwIZCLSRq8klZb+AskbBb5HyZXBFp6CRwTPkxAvlUC6AT4V6Anylt68BnkocpS7TfFhpbPJXC4A5/VVzmPiZdHhwcv9vb399VL74X3fDx+7u17Lw++32+wtXPf7SC1NYvTetD3+rv93QaoS5AFBwqlIEFzUJUNYN1ipj1kkVGegpXIV9zDIh4FIUetR61uxwqJAlisq0JB9nwTzNX5e4RDpqhYKrbmcolyF811glKnJyKM+Ckd3kbBrfK3q7sR87+5HT71mP2cbA3qVuqMvgfd8QEYE5kYUNUuOwMzgNtMI+AU2FrQwI8zFQrPKGBROAXOVI1yt2xgefNMJVPL2jjRABOfAvst0yARtzIAUydIfcvG2zkCXO6DWPgKV3szGU6V0Alae4JSdQqBulUBa+8qw3WW6dt66h2ylqYgHU+uYy9e7O616li4QjraQZ84ShItcnPSLklIM/fI0+nyz2U9zuCLLc1mfBKhc2fjr+awpWDYJKFpu9a17z5LktgOdnbcN30vmu/ERt9Kb9lbce4zBYBCFA1UXXAsJWkHVJZVG6TEWUVoQc79LuhBlAY+aFiC31GowrLspBG1QyQaWAYH+i012vraSzai6+lVA/N3ZUD3GED4KUBZXoA4R2Z90G+VDJKZJ41qGkUHEvhCMGEXlKFzhTEEPALE05F/Ipe2tB2Ea2oKxnPFfs+PDuvboFXBCIyBipigogL7CBk2napoamQMnDlXeJrHE+9NDhE2LkDCXhYOKqfqfcRe5lG7XDAsEWTAAD5IlvHPpEmWeOyLmSSgxS7jKAqUDFdtw3FfI1Q2vogRJuu4dVDv7x3HhgngPk4TVWaUNEaiQuhEze3DQV0Lv2QOMovfqu7ZosYA2l4SLEGpJAVjHronDzxSf1P7Wsbg6WOZwxY7Wz0lROybG96fmrhXLW0Ovos2D0TeJjL0lLimja474PDgM4jQNZn9CqB1kXidgkMNS5sWUW7zzMVfDRRJOVRoNUSaOlmuL7KOqTXVKCDlAUxlK5AiNY3Mcv2DgjWCNKblVMcOVPtG1oviDXiKJr+p6AhDZGJLvKxvBKrY1KuqGJcs0YN6+rB2vtcQW8FJK9Ae0rYqEhC7+RAwtMfMKzzI85OPez9effxl+erm7PD9mwNz+R/nbwfPB8fvBy93By6Qa7IFdkKTD6kZ5eqaxI71jBPRJ0Bif3CMZyOrpMSHiThXUyAQJ/GDo9Zw5YI2J0zon8911XsSC3hN7iDLDtcO9bMF96355DfB1DS8BK2cXq5N9ab0ERQxRjC5CcnD716WeYsdCMWnMvg1Ggd6yvH8DmcwQC/4CIYBfsVYAuUYvohTeNL7NZH2hheDuABCKn8G8QrTOfoMtwkmwLVNsgRbkuJUN6EMPd+EFzc2QVkop95/nlI/EhSkEaQ+QJkQ7fQO2Y1fbZQacAPurxQLIL9aZW61p4pj4gJ27+75jvur+jxJb6wlyOxj0L3kZApkMMxjZCVOzkZDsDRxZEi6pyrE+hiYQDkBgmHxBB7oOAwu0vlcmuVaiTRud3UeCDBO4KswlyxtZzGb4V0thN8MVqjEq9SGIOoGXQRcxktIHpci46HiWAntHVoaPQ1lkhqizdfe5KY3j3wVoBnIf2kYiOwXqk+lwEcIxRFHjsHgy2qivJUvsMJl5pAaYHUyS1M9MMi4bg4n08ABkaNltx/MVstIrlmPkssgIh9mS2uZWGy4WDJrX57ly1q+fSvtrPYLIqb8V0vCdQ5kB8l6+sjtsC1y+0BEykkdS4u1hbH0blAUbASGdHg2yovLViw0HDhNsB6rfbF19sN2F1wSEJPlDkQKeARCBAyXEI/5BqT7utMVuq/68E0hDomz8pgKLlUiMJkomJyxhUsZIXgF9RV8kaXfjcSAqE923ZF6bcrc9fv9+1YVArcK7tUBzNGzxJsuGWNIKDxSWAsneXfx4SdI9gz45KzKAkIJShT4Vty1MH4gYOuuWCESLb+ybLX8MEQvDWa55adMlFp+erewkL/6ynRFLmXuMT7kR2Yti8S5moAFgADbPcLadAk0rnxRfey+Ly4cRSpkwtS7L0bs4nJVqlrBsQKGIb+XkPaBLCHt20ViC2ViRtBJ/BKso+ETNZSyYkOpuDcx0ZzrKo7NEJNQGY23IUu8kMa3/Ya9W0+81PLdbPzG0x/0u9e/nJ5f/vvFu++BMA+bxQwZONOMy34MPAsKCooVJ3LhE5tsBZwDF9IUHkyKWmXAVazqdmz9DN7fPzzc+z4/xv7ufjM4HIqFCoLeTRgtIN4jgIWtYMfI8QE1HywWRX8G2fG5jmkH4vLVSV9Qd2uupzMqGamvMbAfjo2GCPxZjJ4N/iwfxkG1uBZEITNuEqCEEKMEoLZE22K1WyBC5SlrwUP26wQ6expDM0LHCnYGDFoh+rbQmVoJzedyjxNo4nWhiGwbazLfI3n4SmEblZXDAr4LDXSWcVnSzhUnJT+19mnl3njfe+4fqMPJUZu8t57bM8s4yYtLKP3ZuUkAqOGkcgtMHqT4EZ5s40/tMJmpfEQ0N6zKlnQQM7OEUFzvDYIpjFOYJYDwXE5Vt6S9EHXV8ctd/9r4+dof3Kjl4I+jH28mbaR+pTyZkucED41JI1gJ8ww9JwMkBQGNqFdcyfKwVZagCFyWJRPsnGFpPbt5WkaKBKcAnMHEV0M0WWNxToouV43JW2ZGLU8MMegoMKcKQRBFNyi9aZxbtGUW6HIiIoAmZXuZh5gtSIVR2FsHMa+CF6zDR8B8FFUhICuWiyCyjl1FxbXAuwLSYh0I6fsQl1oIZnuOliAnoYzhzAmTdQzQLJK6aumfiMLO9CUc30yViQ3OCDTKW3CQMh1pAoAYgRvB8SRgeANuNnegIGEoVKMTsC4WTVbDYrJoDzfIkB+qtp0PX1+K16PT9ycDceF8H3fBjQq4hjDTMZw1WSgXDpSzjRJhQ9+dnbcqZWiZHwaOe2CtrPM98C/soW4lEA6F8djl5dzfhqfOIqDAOFC537ouHeW6A7kpBMIK8+tEXXcahCqc8iOMVED2FTvbmSw13Xs1HkQDT9SoM83JzxRhQQD38aLsoNi4ia3z18cvDvcOqfFUJC1rHwDihYPe7l5v7/Byb3fwfHewu/tLMyrP4GYa4DDzUgPODktFJWXVNnyWkMrnvTPHThsJnTzjTAOhKdODzCqaZCHeqsj3kWXbEYgAVtIs63ndUS/A/QZqAgYgkOFN5k1aQgFajU8zroh1EQNsUozlGZ0Hi+xcSxSU1rej7dJAHCH5OZf2nDdZGT7b7LpTKjWVMCgi68/5cdro/ifS3KOjljR3KOxyDkGeoSZWkBXRKM/Nw6tMcUoRVo32ffFRUWpbSOBvqU2YXkFmZzjsiigkL+zOluRCxjZSKH8MjIgbndpiO+QKMrKYqWIr72yOIZvTRedemhRwXWKIL7b73MlyQy5rS3DTojSmgxgkWYxQLdpGfWw+M4RDDSyq5SGbp8KGd8t8G1pWjCYXNE7h6KS5UuEbuQi7GOlqEFoqIRCnXd0hD/fJrsvU14CoDnTC8b8XzWMQFUAdDYTrzH+70F6pjD082/VxdDZgJ+OMWNVmUO28YEJG5cypYx0EZNcUiS0AEgXWIkYhilJbESbSc9T5CmpcYi+GoL5ZdSTUj1kPxPtsHQQ5VPjkbSo79EX9MUu6lE2zzGWIDWDtMgWxiMzNhEYZUeTqkwOWNRLHIMAvg1rPQZ4AT8usZFltpx/PtGRWiSpUHWY2ChIXgWHhFQYOF1wZfqDHtF4LOOUohKFVZ3MQ3+b4zaZNXzd2ACzMGuiNAuJmDdkH/YT/8Jm4/7nZbEVL+wWHUq0bqMh2rm8TbDx8sHKjDNSqrdx4zAnETeNIGn9FcX7DXR1UIKkDK1ITtKPA7TVgaTiM9UW5f/btVudlOa1xM6QfENLZqDYr6Ede6qaCEcA4y7PgyWfFmDHkBGTiMDfAMkQ27MuVM5SPC2q0PFpzXH/nn0NlWg7zL135y3SldY6gdej6FAtm2Poviwly7PQrl0maolH59ZvqR6Ks3OOgWaCAAe63GuaZiSZ6HUdcBR27ZYWDG47O9nbJq7V3kNra9bnLhPzeXQ7ADAVAUVyUTyOc5MMI6wwOt08xFKWeb00ztI4eVJdre4pBHnru+rx/EXPW8jSbpT3KLUVAv7eOQmNAC+KBluVkCcZBe+91eNP6HMReGImSOJ6DVGFHvEVM1rM3DwyglrahqRrc5+Fx1IcHTlfAcx+V3zoft0Lqf5Qxj9e4taU5kCc4egtYxvTPjQZV0XmkHD44GrSpVtw3hmraBpdyr9hKFwKCMW6EE7ylI9bHqf7vkaYpmn+Fov1L2jaTtpw1mTttmOaSsf/sYtu8RNRCscxxn68qZA3Fd9Rb0t53RcLLpSxPxjxSUquxuTtelm+YLZ0jeGaze1QmWhRFYOoz25QLoJCw7m2vKr5TSLy/zRUFLNtfh9fh0OLFi7yAft2xqYflh8hcd3DWLZ1jpaLAvOj1YlED1mKeD3HXzSYjwdrPyewmbJmedEWOP6LHp2jY6D+ALH8o/8I1KNy3/KWbW/kLB1RaK3d5faw87Ljqxs+KjtmDJZgzVyMJlsgSAg/8oLkAlHDlzULIjAK8v2BR7ktskTQ3cF1CqlLvrO9bXKtoFrNKddBNJjnXvm2GAy5nP+ShspPhvLqZa0RRXSaxeIKxmvJeur5VS/m9cvwnq7uP/JaCe4vIuyqiDLw04HtZVQ3oF/CwCgfWwKL9o1LwWBWjJDw/0qJSj6Ropg6wCSWUW27QBhv52zxxw8M2wzgGlGj65liGEckwIEPWnuwv1tCwaylGp5evxfnrY/HyxcvDvsB7vnmFQLoLZm6sqdolgJxDxQnQgK3YCK/3VIhV/jsjgJvlrdmVPzVn8NDnBuHeuumCNp5vXbwd9vb+51pZJGOZnUcZm8k4VtRfGCUlAzO6+CBeglEUV5fHPFCa3Yxyrc0/cHRglLcaWXWa2uAanWBBu808pQzqA/YsNrI/B4cHe3JfHakXh0ff7+7u7h0cyvFucxTovNxkkdmFRGwis5biOJfrGnAZO48EUFgyR8moVerrpWjgG7dWJ1XA3AMAh4pd8bbL7F3uDCHC2DzIkXDJna/4z83kdz3p9Z43BYgblxDDUA8jKeZQKKIoVfq5QeRFsc76AjVlq+J/sfmQWxnVtgmUzXAVWwsl/Ai7tzgphhdwXSJaearowmEDDWKfbZfUVOPElvC1VtLYwmAJh0pJv/ZBcHe38Uqd0eoWGwrM50kaBOirZ9SZx/gGAR/wqwGq8McSLX6cUveZX2fQsnCPboys+06BcgynjInMMcg7MgE/l28xfG7OO1ejsmJ1273DnKlwsvsW8C0yUcjBq5aDu8C//iaHwsq0kObg/zFpzpWrCWNjaxKlYZNAhxu+j+Kfi0DZ5CA1msAc0zY1GnEJPTV01+7TXWcY6x8UfvyMFeBXShplhiCB9A2eWk6x/9Cp9geRHnM3B9uZKn4/CS7q7PDbS3Yw5OrllmTnrvbWkXtOmG7bX2dyouaRO0THXdbOb2H78FtPxrqvIZcMk76Odm73O4h8/ZasnGZNtxYwln9ugfS5oBBHf8TfjE5F2YK/cK9YYRJ38pesDJ0SZ9eDaun32YiGx1DVsZrguffGXJZHNtGyf6nA+SJ4GzHHSYoxGf6J/ppN+H5hHMUXsQUawpNsiZGapy1i6antrlD9ab8GdiDcwr8tQb+QIj1A7u9fKDAvS8RdZ0x/vc5c3buPl82zkU9wM3DukgShx5AczlQiLyMhcgqSdlIAQAuKaAVZ17mnO+mTKFNzN7BKI4SoPjyn/G85SwuW6DfFV1VZKB5uqFS+SGz91z/+c5snPi8WytcQI/uVdkJ9Pixv9/JlI2UoZE0t9Z6CSc/iOKkCN+1KSskyGzrDCRBRdA5optDXU7xWBr4d0qaEZ5UjHACPI59T7yiIphoHEFUIAHhkBqdP6OUUKFA0LkDdRx7cICAggtGc0zdq62u6KUwMcxPV09QNDdLYvyBvnw2ABDgxHoZwNuwNwmFDvryWaQEIHQjhPt2GrNJ8sVj0Jf3cj8x0x621O+9Hx6c/XZz2cM19Uckq+IC6k/VdM+3KK/iUYfSf9/f4NSQ2AexK+OA7lZqd0Nr959x5/C99WZTThkR9TXbiAHLP0gst2Ah/cq+QcvWTXvmwg/rrn8DczSJsuHzq3N1hvHdlgvt7/BqSdUOeAQgsjea5JLTVgDp89tuLCmUCbp07/7otVr6hqvU4mY0N0cCSReTA+gZNcOMNVlQPdfYDEeSn0BDFSWl9IxS4L3uxN6doy6QzdIWRvyEj7z6UGvFV3Or2nlHA/5Yaq9Ulf0NJBrP79/xx/mXlgtxC8tNIKSwG/zdD98y5
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: eJzlWN1u28YSfpUFr2xAlmzXcVGjKOrETqG2SILYQS8SA16RI3FrcpfdXVpxBd6dJzmPdp7kfLNLUaQkI81NL9obm1rOzM7PN39cJRm51KrKK6OTi+Q2V06QziqjtBd4rh1lwhthSWZCaqF0ph5VVssCj3MjMporDZK5sfza2IXUykkWBwLhcxKp0Y4gbVarIlN6IWaFSR/GySgxFdlAOs1wN+jmavEeF027S0BUSStL8mRdcvFxtaXvB63+qElMr4SZh/tnv1PqwaX4bSV9jmcNfvzaqI7rRomlP2plCTd7W9MocWlOpUwuVol/qpjeeQttk6a5Y2JXsRmO358eH/M/6OthFz/KqipUGkyZ/O5Ys1VPXmXZUK8i90aNwFkUb+fBsPbWzgKvfMEHA2cMrb/JwW6WxZMoTUaFYw9syMUyV2kuSvmE6M3Jkk5JOFMSAuO85F+IEFjoM7yrweCenKdSHFhaKFgfoxgPR2Je65QPQDe9wk9T60x2B4J8ejgWlwMFunsQHM/ICmoyrLTxjKoZiRI3yQfSYql8LqSoY0S19LUNItbSxmIaEVkxJwOrVdcsNVk+yyhVGYxqL7OUGpsJuL5UHncjSIw+EMo94uGIbAIQg1sKB8KC+qZYsxQpfAUpLMHRIzH/GttyYYlKPDnG9ecj2Hek9BEcJGfSIYxzWTiAbAsK2S7cRglSqZSAVYJn+izLKsDg/OzF2Yk8pXP69sX5d8fHxydnL9Ls/HwHFLfwTL2VFkNDxknDkmPQp1+hA4qB/bH9OU5NuXP3+w5n7GU4IUdk+kiZbKEoQhTBKtQDAcfvptOhcrdBsb+qIBJO7abJ9Rrf8AfLEa4CUuaKLAArosixeM3BXwP2UxT1KUFFw48tsH9KxuIV3Ar4hvqINCok7hBwukVsg4MBRY0cfnpnDVxP9mscvS/YcnZyuifY8F1q6iJjZaDS619GKLQ+1GMNzC5JZCakWy4fQdGlAYCx1lBUrYoOOXb18mUoGYG8NJZEWyhbdDdNM/orxQpOt9IN6uzHWIlHXZiq3GhK7rbTItbrXV8NTX8DqlhYqJfGwfOy3O/soYBX6GmeXcKw5hg+0FNaGPnApUA4tp9l36vsXkiH/yz2PsAz6P/FC66ZDB5llmjqF1neBTKmr13+xnigNLaVW4Ma+WX+K3pUIfu4ou51ThYonkur/dJAdPD25nCPQPhC1yWHFj6zRnFjVcYld7iJkfYc7Lfv4SHCBeGRC9jcpz56MeC3hT5G5JbAfr0j3IlqjYjWaUrOzeuieIIKOQaNMFSsmP8s9vShmJnk3K6QTt0Qsofx5KuGgX46kLXGvkJPZD/y81Xv+rttO7fTZMO9cTCmNloELbtiAsuaPeL3BGVTf17uMbxp9jj6g5a1z41Vf1K2xzVn/2LXvCdnaov04eIbGsiOg1585SD5z3LQVK/HTrKYpkS4ZstHYHKU1hZdKgzJl5X6hfjxjrvQS5KW7CUQGE7YarngNaE/NOMUSuSGV4wFBVfwWnCRTOLCMdkUmMmqvyM0CV/Oqu3bPK6oNK3moKst+kGSe1+5i8kkw7sjWamxWlip/ViZyeNpwhpvze9Ql3vxM2JcfL1H0t3GLTeMjhjUtXO66Mh40G5D0a+bfeiyzdyAtp2afPluyg1RcH7zmBBBORY8Xj7Kou567/1Azr2I14iydp5nkgq7h/qM8hvm+/uoo7gXB0iL2GAxJ6giuKGSKR2OBI0xjg3FXoiW8fsnJBV75AjK/XAfJq0+DFbJLPx6vZ6rfv7tdte20AjaLllJ59bqRUmtzjwSDJQQnQdDSrIP42VJl24cuoRRy8vxOrdlGnK7nRoSV1eVsf7HLqS9FfWnzdEQCxvinTzqmMTB//7z30OepqW4WVKmXC54A8GCl+ZSLygMNkBaN1UE5HGLX0+AYcnCPOTwppgfOQNqUgvdzYqjll/OsB+lqEV8jN1mhDsztVCe905speTjFGUKdPLKZMJTmmtTmAUqEEKsIYBjjlWMlqJAgy7CSMo1IXwWmAETGE1ZCCBoEEwmx9KBAhlG9BCwYB7W1boI9riw0YrQ4sGWQR3Ws5QaKyJvZiiupB1tpkwkjUQwxen4eMfny+VyLMPrsbGLScvrJr9OX12/ubk+Yp5mM/tu4sC5k5m05pF5nV1cRmK8To9Pz8bfjE/CmGech3Y9ffj7x3DCyoaVt+sWf/PHmhbhHrvZpCokSkrTOmzVVtSP7SecUHB6BlwMvrygduWwmslXK16OP9iiafiYt6dQ2+EtaQPEYuGFjnjOui36WY8cvG875KF49svQXjvWBVNztQzlLa5kD1xPh1+OGp5t20rA2kUSLimV7zHvdPKm34h+uuaqJNuStSnXD6Fctw+9r0JDxbYrd1SB//Z2syHL94xJFNAfOvL45lmGrtatXcCGN83/Af8/BME=
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: eJzlWdtu2zgafhVCN5MMbMd2Tp1gMNi06SGdoi3iZAfYJkBpibbZyKSGpOx4At/Nk+yj7ZPs95OSJVtux0HnavemVSTyP//ff/BjlAgbG5k5qVV0Fl1PpGVCJZmWyjEjeGIZZwl3nGU6lfGCzaWbMDcRLOVOWDozkxaXmVQj3Ylakc6E4UTuMgHBWKuRHF+B0Ed/HwcybvhUOGFsdPbpcUOAGyV/zwW7vGB6xLhievhFxA63JH3NuJvgWeE+/eUpgk0rMuL3XBoBjs7kohXZeCKmPDp7jNwio7PWGanG0XLZ2uR4XjIJqslkpZKn7PlCJLOoGK8dqFiPeGq/yfuOTttMKyssfe93u/QfbOSEcvTIsww6efMdfLEk32ONXmbIuE6G20H9Gp+VrZx0Kb1YmXxD49KXYz0TRtngX64SdoGH87ERYgp54FHvaERBOi3dYcZcSesFxEeOQxYHRgIGYE4zbtlt5MmRUkanqTC3Edt7ffHxat+z0HMlDFELt1QM07AVT0sR9NBW2rWlahOhIbdiZdrK1p+CL1pRbtIIdl03jUya5m9FI22mHGaO8Cwe+DTzRjo5Pjrt9ft98Sw+jQ+Hw8O4H5+ednsNs0XLMgB2JX0hRjxPXT1/GlTfgyKZgyxdHAEf+MXK4P7dWPU63U63Qfyfgcw6fbYnHYvhzBHco+f+ixVTsGSB9j5JQHbdmfvEucyeHRwUbzqxnh5kRs54vGh/Re+PAoQUhdnN1TuGQJpPZEzIgoCCKAs2W5c9xLKXe+hjMmkxO9F5mjBEC73jpE0Iw3jC1RhmJZ2chMug0JfcSJvI2D3Jri9vGpK/rRNaEkIkOagsBkg+bXYn/QZ55SYxN6LB4rIgCb94muBCMXQlCCdwBMaTOrngC1tjB8QWY2G+xu/w5HiTDaU7TFkQZZmnSmmfEGUwHQs9NjyDZ64EafP9xnu9ogjGFUnwslCUj8U7HeDvu7gMAi2WlsRAH5Flko/cuAWpPZhwT7TiMtQ6FVx9jU2oK41qaRKWEc2Q47agukSdWVWJbyH0VXmmidE/jgWQUsY/ViV2qhORIgUyl8N4ReIayVNpEfdFGbEBqhE7vm78YJmFSClyRs87zBd46e8qZvNQ+JAxvX0Wm0XmVt6xcqw48fGo3Qd454l0oNS5Vbfq3MpEsJHRUy/FbWTzOBbWakL7WKf5VLUYryQvMhVZCinpLtULeOdeJLsjvqRyG7R6H8A/2NOX4fBIrqVDsMofMMsfIhkonoG7K96Gl2+4nXgvTBGDcPDfX0FOTrZUkNLbaG98xFeq7MwrqVfoJqiSwXVu0wW5xJOHP4a5I2RnTsQThe4iJfhEc2HrbgF6wiW3NaFuPWeVT8n2m3wrVK9/uBKxNkl0t6y55rvM+Ozop35Dy2sqB7+WhaFo3nwzMkf/UWVEtFwLi50Feex0OsutXOu85CYryhiR/IYmUufuQ1P9vwCYIuAbhYDaQZ/s4Fka1SuaihHqXsrVPUH2lpBHSUWSw7Nxjmad+qz1DOhU9KZ8QWhgkW1wI8IHITGSPiSk6njttqTUd1q0TAcw8ei5RygGxd4OPrzfpwdMHqgPHXaOrnjhX7MXXGkfwxDGF60Bxaug08hedvny+hW7evWCPTt9dtxh7NJ5WOQSwY4I9wEzkiJNbBk+Id6ZeIhF5mCDgGKX1F2sGav+d2kAQGFpmhqu7GwV3hv248PkSByPTr713DAcsSH5t/l8b/DmvN3zLVwFbzuL1O/2j9rdXrt3fN3rnh12z7rdfzUzoaRLMvgYK3GeYmyCGQaVK+mQ8SuAuRx8YM8Aiuzm+gW5W6waM54jYwwp8XxB8T6TSc7TkDrNbAhfCUFbm/PVOqkP8K55Ev4cHR/1eF+ciNPjk5+63W7v6JgPu82u+qqYXISfeBTjyRQJmFtqNilLJwjGGBDrqBmd+AGpqPIULGWhDKI9tEf3bV/X17uBTZE3DDFaJ0xgpDQKKrpes206b4VxiwSW6BBWQpBEGcqrCH8+LX53i974sBlAoCBMGz2MtNSyMHRQcsSBrL6jyIoqBpmpnLSQwpmELf3HjWRbl39QNi27K1EXFSj1nbKyvblgiVY/OHavMFvJYvDaOOXrlC8XmKhpftmnlnHZ2ugT/astLXsxx6FzN1LMQKTw5yhPU6rJE0xHfr3ySASOwpZhnc6QE7Jn6AxW65gtF3tPWk/UezVhjDYvENdkbHq+qLG/21R0s/uqbm8bb1bOg2bLLeS3+L7y9/Mtii+XWyx9oyo02WKao/9j02AY1LkB/tHkPdK5ahro+Imrrf8tA12Cn1EoU0Ar2kF4Nhs28o1DnBvpFn4Pep7JXwU93tGO8rngRphzRKB/Q1rzMS1MAwIUmz28hhQTTZvWsfC2oA3pWXQQ9q4HASkOHstV6TKMQbPty9cLMdWFyMVmrVrtJPjW5pnsSEyIynWkPpj1o+Y6dQA5i1ZzGxkbPm+hdFfZI/R03pulVVZu4eFFsZgNBq02s+dFyoapvzFUf7xk92LBKLFp5xGikYZiwWY8zVeLuM9rdD6zwIZNc+s3TYDzkXwA7vqN8ecgI/vM9pAPwhNwhsvUmyHjsdhvMdEZdzbInrHi4s8LZBNZpA3hfvns2+26/x+jof/rVVnA3v523dTNVwAU+Hv0Yxm3thQvUCpkpklhTQi2sqDPRV/W/YWqByHX0eI8og1/mdQogD7ZptCTkiXPMm3cP1YurVwiX1ev1mOhOtxIoNUltvefP/+9T/0NZ4O5SCQ6Xz8soGEPSz5aTyDS5Khwp488GZOX9Iw2Db4RRXdG81o6alvaCgoUX4aPCAK3aBX3+TAV1Lj515jGWn4AGUuHRJ7TfOw8M4tcSlCDkzBQ61SPAT1wsQIB8jlnSswxns1ESgFF4OMRig8RE27hiSAE9TQMZbEGvEhO/aR3WBK2cmM/tNGUDp9x5mt7WMJ4OadcKegGoyKzhbIe7sosQNAhCPt+I7xu8/l83uH+c0eb8UFx1x68u3zx8v3gZZvuLKv9VOUHyp1ExzmN+WV2rbbUfm7oHHZ6vh/T1kG6mjz088+3luC1OvF3/AJVxK0TD+4gSzH71fbZAR8/Fb9L1RcZZ6ufk4BEE+hAxx4faRt1Y9Llkl6H34E8cEpLbki2z+11hf7i96Wtwt4T5K3/zOTxiZpXAsoZNz5anyjK3lVRZffZV39n2ypPib1qUZeklHNluCUtfgpAIcnCZ0KmzNUuNjqBZb2OvX5J4MYL5KtQ/96jfvFA1LcKtVkAggj0L5WqrVd+ptAGDv+yOh6+fPXCCjLDaTLRHer5fwHWIBl8
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: eJztWM1y2zYQfhUMT01HphwnvXgymSa2m1HTNJnaaQ6Jx4LIlYSIAhgAtKxqdOuT9NH6JP0WICXqx5WTY6cXGwQWiw/78+1CiySn0lImPeXJ6VAWjjqYcplVpVdGJ6fJ1Vg5QTovjdJeFMp5J2RRCD8mMaPB2JiJoFvCmp+X5DAvvZibSmRSC1cNWNeAhDepeO+It+HvrSwqyCod1PRXYvkFa3J9MVRU5GI2Jh11WQJEYayoypxHsjk7FVfQwLCEckGbk1MSQ4gySmNHUisn+TIu/aQ/aRY3NicrzDDIr7GQzMZCWivnIhtLPcLsgPyMACKDMpeKcyO08QJGg0WEifCDNuhOOokpyYazejBnkhk9VKPfSOYfIthwuys2E2QtuRKgMD5dJCfHx/wPOzxEeCjLslBZUNb97NgVi8RlY5pKHpWWj/Iq7s5Yj/ZvpJYjmmK0ex6ktv1KG35ji9V6xHSlKJjX1ZJOmCyrbHQLvKt0rm5VXslCjNQtdECFpWGFOzWqOjwn3QSuMTBbQZ46IjczXRiZt/wJOyorMJQpTKM8TQNkhgaszlulR1jwyhcULXvowp2EdDVNTj82wilcaGaI8856pvLmhu5KZeeYDadHjKnSyquQFfV8xLk739wlRbhnVBQ7O3bmVzt2dcWz2zsapDliuIZ/vew0dgmxmizj9jfSTsiXhczoG93Pwcya4P+VqvsDIOQa2VtkUkxP8ELcDrBZYVxlkacjS8FBCIwMifIg7x68zdq3LNpGy9836/NvVuffxPP3W0+NlJfFB1iYvjV1gu2iHjELivZaLq/4rjAUHKspY4Ud/rKUQ0phs3Ku4gAIidNegKHVsGaEFusxZUilI/ed987PzHS6gU6CqXjtLTird/7097P26sP88e/22a4YL7YM0Tov4u6Du7TK0+/7DflKSxFjANgLmBu87zbwRgX1AbWh13oGVBiYF1wTiLlgmm9sAsr0JjNF2gqfGsjayqkZDsnecM5FOt+7jFgiEF6+V2Q9vGFfHpaS2eQhQhmV/rBc5JD9Yk1oQUire2S8mZDeAT4OprznSK6FMWAeIr112wOy25dGs8K+iUlg6Quc7oO30tsnB6Qap90v2f6IOB8oW1uApXf5Zcml/kulLLdYHx9Wug5n3CGKvF7BMIPPIBrgWG4n6tvX0DRGe0KW858Fnh4//qo+pH0zstbYM5MTJxiPz1un7eDpbPUw691rJkLHSSOyrO9OTksmo6fHx8s96vew12pL8hKthtJl5UUpLbpDD5XL5R6DvNfoCMbGqj9CzG2a5oevbNH+W6bp4Tyrwel1yQ/HbNkImxyhyik/x6UXyYtSvSYeIikWyUsCy9sXMHCY4VvLkWPr1NHLhgCCseHeeUTBDpKlk27spLt1z++6oSIc+ToZIiQXztxEfU5TUyOGXGULzI29L91pt5tj7UiWKlUjK0EgynRvTxJGuqnjEjC5Zt+jxsXlPZqu1+a45KiIzmyMsvKKjBOow3xatCe+NLzBxbQOyBBlu6X2XU9MaC44bJkz291BKInNI6e/oacv4jFiWqGDwOsMbDZUd4QXl/JjCAdIoi++w2snVmZvpSqCGUrwzaOOoHSUbqk9FfXGZ3izWbbIEcA976fcZLXdv0gG4esnY6cSqZT8/OFq924gf8fvBhQkRKdzDbyoqcbM77YNEGJlwZCKbMN4WLJKM3Zd4GWlh6bJaZmFnEbyKnavq8rSWP/jyqVrl6hX66nNWFgL7+TPapP47u8//3rEj1UpLtHPKzeOXTPdxUdnaH7azV6IPJWxlwyeW6iWoudFeGU5KoZHzkCa1AgPslA4/bxT75eDglotpONWc6s348OcKVQuSoM+kbKxNoUZgXngYg0FsV3VNBMFsq7ggGLuCQQlB4gJPw9K+C0FZ7J4ZsAuKjSxwWHhepZGVRHf4ewzKYZVUXDk5oDDOPHo1LgbjApSJRRJdkeTBQg6BOFJerxj89lslsqwnOKx3633uu4vvbOLXy8vjnjPct3Lrv3AuZObrJo2ZRyqmUaiv06OT56mT9LHvLc0zgNdCw+/6ff9+rEdxK1y8f8PKV/zQ0qdqZ7ufBcdDqhxWTt+UReFj/XPKxBuygJXtlZhAP+O4TkWXSwG0tF7WyyXPI2G0Ia6BI9LG9IkVqmGfrmSTJilAwuVXIrC7QJdbxX9ZbtsvbpgIpM1y60ZfhIYvh6w9mZJz1u6t8k+QuC/XJb2bnnGYQzOfb4Sjyv3bljRY5Rmy16jdP8DU2Mn7Q==
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: eJztGtty27j1VzB6SnYkSrKdbKLu7NRrp6m6SZOJlU27iceCSEjCmgK4AClZ9eitX9JP65f0nAPwJlKVk+70oU0eYgo8ODj3G3jfiURiRMhTEXVGcx5b0YUlGxqZpFKrzqgzWUrLhIoSLVXKjOCRZUO2EbOl1rdMz1m6FEybBVfSctzDZlsmU8vGl0Gn29GJMLQ8hgM6oVZzuXgHSD44BACRcMNXIhXGdkYf7xunC0CUH5OfmmoiBPGLO75KYgGgT5/x4fwkPI3OxJP5U/7t7Fn4PBqIIQBJRJXwdAnPCg6DXx4VUNXtGPFrJg1KIDUZCMCGS7HindF9J90mCGxTI9Wis4NX6ZYOs5JO3XX3CX5DDzwO2Hslf80Ek5FQqZxLYXIuLFfRTN/VhQYsZVawuTYAAxJHmoRNA/ZhKRTb6oxZUIJ7twTehek6ZMKsZSiYyZR1qsgFzqSiBZB5Ku7S/HTkP2qlARHylEnbZXzBpbKpEzqPY+G3w+tW6mGNKZ3W9q3gsba5biYBeyX4WtC6Y4jpLM3lsIcg+KQ+qUmVXbLDijSYVvGWbXJh8QwwgNzRstlGpkvG2UxwA4A8DIWFvfpWqIp4W3Yodv52zG7Fti7qlN8Ke1iTc6NX9NZvJuHIhdJG1CgO2ESj2vw5PQQNgVvUGz+goJkkGxCEF0R1kAhiYPr2/YT11yd953Z9Hq2k6vNEwu7+Pfz9UWzH0a7vMfQAw5Sh/tC3UOLTv/SusplTwTiCd47tMmaQNTntVvmqCAutT6oMWdck+gQsLAVOQNeI3h39xiwQ/wYOZ3JemvtMAxsOrS1toI3hVQZmJ+6kBdz0PBOxVgs8FbCZprl6IGQm1lsRBexcsUzdKr1RFaftonrqPtyunNx5yA9ypF06qo6B4Bx1TigskvO5MACwRyXYwgpszXkx/ppzGTvV/nEyecvOBoMgj25OSGV8q4u2FuR8mP83Ua4aVJ89F0N+Fj6ZncxPB4PBkJ9G3w4Hnd01orSJVlZYRHIyGOAfijYqxUeeJDG6E/DS/8VidLyvHJoYjFSpdLt9OKZtcfxmTqmgJPljRyIP2vOS8G2sefTexPDDnzhBJoCrbIbheCaiF2tYtbAUgUBnscCNVoRGpGD2+Hwrkysb/yQM6MWRCaupXEHYBfY7wKAXjJ79IsKUXqYklTJ51YP/eZGhnMdlPhK3hr+ql/B4w7eWbB6S7VqYLQNbiaPCtRwJXbBw8qCprfoNGkFdnCCthl73iT2YnzwPD8yuu1wtX35g043AB22dFsy9VYP+8tPanLeuDacGkrvXAuYWTM28LEEaXpzjdb6/gmMhpBTwEDCFXEMYJFxIhyD7RKqwWsKoY0PQIbFaMfDjjL575agpjqiWSh5TXZnLNE3sqN/3K0GoV32Etn25MBy8d1d3q6M0XDhghlD7xVqVApWt0JkbkaFbW7rrbTabHsh71ctMLFSoI/De612Ld5eUNZy0LRI0aktSApFtnRCrlOcC7WJKPmULo7PEolIhjcpVtkJOhzm7p4wbg05MiWWpwWx4HbA8q25uRsyh5LGYJkqQWjrxlVwM2S23FyKmjifSwoEbsdJQWUWZE6lgax5DBm6GiRCjt0pfc8UXAi32QxmGvViJqTZ940ZIT/nOqiSJLFtaeBhCAqbSDDOhiuRaRhmP2cI5hCkk4Onp4hq3t+RYkYDiQ3SBu41CO8J3WRIhWyATaRg8ckqDqVjZ46Z6VZiFo69iloTJ4Q5AcamktqhbWw+5CkXssoknN4CMpTe1FUw5jUWoMPWNuEuk2eZIHXPNw3JmW964HVUy6jvKN9e7HSa/hUx5/IFquIeq99Jtyqv3mmpfUHZ6M748++nCvyHdUbgkq/wdGesUDE3JKPhm6s0P/MOVMhQB/RpZOViFwzdG5b6BffjrLZhKKhY+hSohImdYbOp58q1BeUBZ8tExMbYFl+PLC71aMTD8VIc6LqrInD4oCChFQMsGmLzJzjVqj9BIazPAYyGRUPFX0gq5eMnVwntzjm9J5x5F68AIbX0/lNZoLS4tfROsT/d3IwWFiHIaRmzqO8Yb3D3tlr99FIPyGmvRaRX/DQ9v8QXEf1H2LWuqiDxx3ZZdcHoErvVghFVeP6nfxFWbytNYQxPzburQ+jqXRStI+XhDSj8KRcweB8KK7Ticc+x2MCQH3RqAlDwAQ/1sg/CmNVaO9Hp8IPQet0dg95mumXXVVMHCj0DlSjsM2TTBB8J6CSC0i5YQSl9zcyvSJOaheHC8hG2QC4t9D0uG1ZkCyA6ivC2Tm8W+ENFCKgljbTMInnxhhEu2IBJtot8u61VoD/D3TXnqTXHqjTsVJeUyi2+rysNnWseCq8bpNGSZ4nBt2m2tsKBs8TIDN5CYYVzFX7RrxxkkUDcXyeu4XLguP2nsocMs9pUDTh/GL7Ha7V3JheIp8DothklzJni4LKk51B9Q5sH6LATGobfHQZtUvoUruXR9cpdZTYkIClUiIX8BxQ7NPKrvgBMng5Y29Qsk3igSKcq7TmTy6oqFWBXOXbnoK1pfuDNoMIiSsjU+3pNMLhiCHzL0qGoFVF5P/wr/eq9f9y4vJ8vlaLUaWfvzFJuuFU8P1Lku9VUVQbMd70H1ludkcPK0N3jWGzyfDAej4XA0PPm5A3Z83dYVtHbxIINdtzaTyIcWjUmB84/6XPhHIMdPskB+CHA2GH7WxKR6tDBGmwvoi5BJfL6snNYyuajX/eXuUpNUbNEEqRDa2WCwa0Hfov1Szj+AwUiVZCkr5voojqZA3iucuGoj/0ZpYl80Z//HonknrM4MWDoa+VxnKnIOUJuTLDlFzdxUaSqIToVNlWLjS2qiqrEWnMTXGEFD3k8+c3j3vyXvMZxnFPQ7GGEg+tMxezJy2SgzMt3SbPKcpufweI13QD/Q1cI5GDStINd8gfdZxagQloCCpcZbsIUgOeB91KiTD+e9mvr3xc3UjgaWSFHbzdglNPmeYIDLcFJUzHUieNfjiQzcOCeQur8+abmsugIqQWqH0Fj3ugXTdSmNKzQKp8tcJmW15BYOjKjPvf/no9e9WWp+e1LeyxSDOh/sXZqa1vAUKTyf70O9N5d3kHHclYijkU3ZI3AuVwikhsuYxJBA/fO4y0SwCPbQjpjf+B3eJqBE8L7m+yklxqr27zvumukPlLiAjz99mDR5q1xBgXFam5PnMHmaMS3WiGCFBMkTKf/Thk7hZag6ylNSzXXu0jwklwbflTENxpJEm/T3hUpLlciX5VLdFkrghvsUm9ijf/79H48x0HB2tRFQIC5dDZt3qdQwriuVTJHTISisJV0ejf08wYp43rMaoAWUZ36Om267fj+WnqzsOPDOkkX1sQUeZnUsI5ZoKDhEuFQ61guJAz2hAAHqnDMlNiyGgi2m0RqGArpCnYFNpO7yDgc3oEwEh8YW4iL2Yk5hxJ4RCywrgR/rLu/mWRyj5UZADtK54koBbyBUiKkCCj5UR+4FYHRghCfBoCHzzWYTcHodQOjv+722/2p88eLPVy96uGdXDjxLPaDvRDrMVnmjA6gxjDh9QSl0FpwGNLpPtE2Bugo9eDmf54x9w61kiP/0uwBvr1gw96HvgACx8+zf+8j40X8tAMAlOaPy3h5i0BKoR8D7+xm34r2JdztchrbRUGgGrrkhU3EBtOhY2r50qDL36J1PcI/Z0S8QWjnJA6DC6EfhCn7B4y3Gx8rHBzucanu3/jwSv35o8PVDg68fGnz90OC/+KFBa6RzEa3xuUER87DqdDDnpJTKu0aPsatWyS9fYOHEfVVVVpS3VFH6B4yZrbF2v7h0JOD/SFDrlu/Qj8BSvy/A3ZuDG4pyzEGjPHA29i/7ivhQ
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztXelyG7eWfhUU/0RKkdRiyXZYt26NLNkxHS8aLXFNLFcCdoMkomZ3p9EtmVHp3zzJPNo8yZwFvYM0acuTzB2mXCmKbBwAB2fHd8i7jq+Ml+g41VHYGXQuptoIFfpxpMNUyCCIbo1Ip0pIf6ZDkUYii32ZKnovgBcmFfC3FHKSKDVTMMhXYx0qXyiZBFolAobJUETJRIbaSJynL4ZI20QiUWmWhDwDE/bhvRtt4CkRZrORSvqdbieKVUIjhz6s0YvCsZ5c0uNH+bTwVCwTOVOpSkxn8OGusbHLUP+RKTE8EdGY1jP6XXk4SuOnsUyn8DqE8fAXbqggDFN2O4n6I9OJgtnTJFPdjvGmaiY7g7tOOo9xiEkTHU469/cf+WHgy7PIn+MTsNwUFwgvZRwH2qOd7PxucF13FVJxgvtMtTL4V20RNDgI3o1pZ3bOYgupTgN846Q2pNvgwFFYOSRclNSW8yZWnh7bhRF/hIHdBErEWRJHBk9bwhhg20jhUAMk4KTSqC/EkahNK0B+slDfwCnIABjtu4aJ0Vx8P5Ph/HuQDl/faD8DcYBZkiibTGH6Gskz5UWJ378KYUufemGU9nTYQ/aMpIFtj2Goqh7Rh45dNsoEvzqpcKJLJ5JEQaCSyySo/f0WBQBGRXBMc3gRyNtxFjyTRhv4C4RrGvnvxpdEWnopbBNejEG2VQrLCfCvQI+VN/fgNYhC/Ugt2UFTNk/pfWCbD+pyO9XeFFgBfKwz1kxBApCTkwi4CxoGzH8/VaHwEgUnF06Ab3VV7Fa1lCfPTyMzfBBjDTTxKdBamQWpuJEBCLigk6vqrDUAONwHafEVjvamMpwooVNUcqJSNwWBulEBH9wimT3NWb3ayYZ8QBmcW4u92m8rJJ3OTIICdeC1+iRnMU37+PDgyd7+/r566j3xHo1Gj7x978mT3b2W1nTuc7OwKukTy0niRSFJdaooZ6hoyDP7CMyDSqPZKqw21V5/t7/bIv4zk6nTF1uaNXgcoVFnvVczmFIw7W1cAfJ15dmnaRqbwc6OfafvRbOdONE30pv3Fuz7VAGhEEXj8uy1AJtSkXZYylzc1Nd+WhNakHO/C3oQZYEvQFrwPXJRLMtWGlE7RKrhyGBDv2eJNr720rX4+vyytfJXVUL36Db8DKjMz0Gco2R10i+VDNKpJxPVmmJoScK5EE2YBWXoTKH7gEeAeTryT+TcVKYDN60mKlk036PHh81p0Kqg42WiIiaqqMA+UoZJJyqaJDKGkzlTuJuvZ96PBUWYuCQJcxnYqJyo1xE7n6+a5ZxpiSAnBvRBshL/VCbpHLd9PpVEtJxlFEWBkuGiadjbt0KkxBcx0mQdN5bq/b09saMU1j7KUlU9KJkkEhVCp2pmlvtzx3nJgmTuuute26DGwLK9NJiDUknywx76NA9cbn9d+1pdwYPb2aeHDjtb3yXEaesb3rfttdctbUG+izYPRN6kMvSUuKKJrjrg8OA1iNAVmf0aoVUX8SIDhxpWJi0DnPaey79aSyTlUKHREGTodL66yNpDbahGSQln8mvMxqlAitQkSuarbxSsEUSwjl0dW1LuiYwXxWucKZr8tqIjDZGLLZ1lcyJQxbZe1cW4YomW6uly7XytIbaCndaoLdO2+iIgdvMhYBiuoVIvH52833tz+f6X+bPr08PXPx4kF/9x9nLwaHD8evB0d2ADufaxwExo8iEqpwxNk9ixnnEO8gCL2B8c497IKinxbizO1AQYxMnb4LEzXDmnyWkl9N/Hpuo9iAW8IneQJwaOfZZ7eyOTa0UBNUQ0M0hm7AQLbUtO9d6Zbyyd65gXiJNBSG7lGAU6tuqlMVCf5Sv6nAmprKSauqx8rDZJa0s5ERMjpFaYqiLM7+XJndiBkH8ig1+jUaAnnDfs0HElcC7wEgwQfIoxC+oLvBFn8KT3ayrNNQ8GsYR1qeIZXF6YzdA3lYtrTpLncJIUtD4JJYHFJDy4NQnKXDW7W5lheF6/mihLvLbreUMEkV1wtMCkEF3DjqgMyf/KMN3+Fc7/RhMdu2Mc0G1O0X6eFCbWEtRkjZXv7+4f9Hb3enuHF7u7A/r3S2sLF5zTgZSHRaiuxMnp8AgMXhwlpGQTFWJ5BuRUjoGfmL7DAx27qvNsBuI7v3RnFu3pLs8CATYSXCYqRWU6g0kVz2ogC2CyQqVerToBwT+YBFjLaA457FzkR6w4ZEOziwZPT0KZZgnx61NvfN2bRb4K0BoVn7TsVP4JVUgyOFvICHCNHArCm/V8fasYYECB51QDmUoqjdls2QO/gONmsDMNpyKKZZntpUlzdZErVkTkPIjIlZrKWGYWmzeW1sabp8Uwx7svpZk2PsGFKf/ZnNY6A7aDtD18AHnoCiDfEZMKVsfSoOUcSe8aRcFEYKqPTodFbdOIWw0bzlIsBmpfbJ3+tN0FzwjMZLkDkYIzAiGCA5cQFvoJSPdVpyt0X/XhnVIcUutsMCOdq1RgTlMecn4sXFEJwTmpT+ASDX2eSIzL+uQ5LKtX5sxdv9+/d6oQeHfw8pZgsTxDZ9MlWw15jUcKa2Anr87fvYWcM9HobYoaIChR4Btx5zj4gYCpu2KBSDg+ZdlyfHCEwQJYbcdHuSg5Pnp1ayCN9lXSFYWU2cd4k+/5aFkkztQYLADE+fYR1qYL4HHtjfpj931xbjlSYxNWAPpiyB6wUKW6FRwpODA87zlknyBLyHu3SGyhTEyJOolfiuU8fKKxpLzmAXIdzXSKk4yTaMblHXvMEBpRNY+nIUt8KxPf9Fv2bjXxUvNX09GPnn6nX7345fnZxb+fv/oBGLPcLOaLgT1NufrIxPOYoeRYuSMbxbHJVnBy4ELawoO5mVMGbOGsacdWLyT4+4eHez8U2wC/2I5Rj8StCoLedRjdQthJBEtbwY6Rwwcqfxuszf4MsuNzOdUMxMWzk76gy5WZnkypcqU+xXD8sG00RODPYvRs8Gd1M5aqwbEgCrlxk0AlhBAmALUl3paj7QARKk8ZAx6y32TQ6cMYmiE6VrAzYNBK0TelzjQqeT5XnaxA01mXisi2sSHzPZKHTxTVUXU7LOnb0EDniZ8h7VywU/JTK+9W7o32vUf+gTocP3bJu3PfXjKP06LGhdKf75sEgK48VGGByYOUH8KTrvNpbCY3lavvxCHFNdmSlmJulpCKvf2BYArjFD4SWPBMTlS3or0QdTXXV7j+1WNn7Q+u1Xzw5+M312MXq58pT2bkOcFDY+4KViL5Dj0nEyQFAY1oFn7J8rBVlqAIXB0mE2ydYWU8u3kaRooEu4A1g4mvh2iyccQFK7pcvCZvmRu1Ij/FoKNcOeV1QRRdU7YXFxZtnge6nKcI4EnVXhYhpmNRYRT2VlmYV1sXjMNHwHyUxSlgK1atILLOM097/9oVkJ3rQEjfh7jUQDDbs7wEOQllDHtOma0joGaQ1XVL/0ActqYv5fhmopI4wSvqVpUNNlLlI90/00HgRLA9CSu8BjdbOFDMu2HQ8ASsi0GT1bKYLNpHa+TRy4p+Z0cvLsSL4fPXJwNxbn0f38MmKuBKw1THsNf0VtlwoJptVBgb+nbvPFUlQ8v9MJy4B9bKWN8D/2AOdSOBcSiMxzZt5xtWeOo0Ag6MAlX4ravKVq46kK9CIKww/U7VVafFqNIpf4WRCsi+4t1qLktt916PB9HAEzeah2blZ4K0IIB7f151UGzcxNbZi+Mnh3uHdP9VJi1fkkfv7Q4eLcijc7q5BtiVeVkCzg4rVhVl1Sb8LiWVL67w7HGaSOj0O840kJpKepBZReM8xFsU+X5l9XgIIoAFPcN63nTUt+B+AzUGAxDI8Dr3Jo5QgEbj07xWXHUZA6xTE2aAyNJaP5c0BaX17mXbNBBBDD8X0l6cTX4bkE921alUoiorKCPrj8V2XHz/gjT38WNHmnskzHwGQV5Cd2lBXmOjPLcIr3LFqURYDd73xXtFqW0pgb9nJmV+Bbmd4bAropC8tDtbkgsZ28ih4jEwIha3s8V2yBZkZAnoYStvbU5CNqeLzr0CWLCX1RBfbPf5Qs3CLL7qyq6FUGGiZDNCdeuCm5gCt4LoChbWKtDj6zTKMWHu4NC8Ykh5S9AOyyzN5Qo/kbdhF8NdDZJLdQQ6blt8KGJ+Mu4y8zWsVQc65STAi2YxyAusHq2ERQl8vuhfK48thxi9H54O2NNYS1Y3HFTHL88hZ3Tu2bEYAgKclNktEBLlqkWMkhRlpiZRpOyo+LWlcbkfk4NL9JrnXCpdcs+z2jVsxi6YqdXxMcjyNgRm3YtXe/Xf7RSX2K3q2XqXokuNpL98T3wHuR6+wXFDgXBAY0EN+czNaYK1AQALJ8pJLZrKQlROIGgYRTLxF1Sm15zVUgWWWrIiSwL3EviKC440PIr1efUO6/PXjRfVmN5C+N4hpdNhA8bnR15m8ZhIYJQnGfDkdyXEEwJiUm0MjDEHz4GWXDZC+Tinm4ev1hx74fGvoTKOzWx05ZvpivMu34l5fY7VIrynrYoJntjzT1wjaItG7dPPqh+JsrKPg2aBAgY432Kap0k01oFT+paRju2wMuY8Gp7uYWHy3fDk4Odjijbd9ygOnvNdv2aoBBNgQW7N9xkwgPPmvqxwEDDOPMe4BJ1uEyRdRkqN/MLk4bqyQzsY+VUPsUW1sk6UkI8OtLNN8FCuMAKuhy7NCepw64/Nu7f7ex5gYozI6JT3d3c38O4NvPsBcXEHP+y3jvUBccEXXEopA2e8mKrJBhwd526YtHkKRuK54hyGE4ickatYB261oBJfMa5OZSVMAAKFcyRZOVRs2awhvw/TY0iB+Ckd3kTBjfK367O9XRAEuH39l863wfhvMP7tqHGD8d9g/DcY/w3Gf4Px32D8Nxj/DcZ/g/H/SzD+DwTf/6YQ/Lb0bbD3K3Lq7w24d+bjG3C93oDrN+D6Dbh+A67fgOs34PoNuD4vE23A9Rtw/QZcvwHXb8D1G3D9Bly/AddvwPUbcL3+y8H1DkzfXwit/8xqNrj6b4WrL0FQn6060tKPWQ/E63wcBDlU+ORpajP0RfMxQ7qUo1lmMsQLYG0zBXEbJddj+ppaFLkmcsCwRiIMAvwyqPUM5AnWafgoWVbd/GNMS26VqELV4cNGQeIi8Ka/YKmf2PQXbPoLNv0F66vMpr9g01/w1/QXrNxWUAeBQn6ff+07ZChAiuKiAo1QNiGsAhx2oxjqXQZ/jyaFbucPJxQaA1oQD7QsJ3MwDtp7rcNr53MQe2EkSuJ4xl8c7xKT1ezNEgBqZRphv6D+M3DU5YDTBfTsS+U78XELpP6NjBleY8dWcCAPsHUHWV7pl0GD6sv5SjlcCg1aVyvuW6AaF3Cp8IpOvhARjHEjRPBWttiEU/3fY01bNL+Fom2kbT1pu1+704uetyUiB8dyx322qJB1JL6nuyXtfV8mvFzK8mTMkJJGjc32eBn+7ZC5dQTfmbyPKoluyyIw3TObjAugkLDubS8qvlNIvL/NFQUs21+FV+GRwcaLooB+1TGZh+WHKLnqINYtm2Glolx5edeLRQ0Yi3k+xF3X60CCtV+w2SJsmZ/04yf8Ej0+RcOJ/hPY8qfyz+0FhX2X37S4lW8IUHFW7or6WBXsuKjjZ/FXuS4uwZzaGkkwxyMh8nAehAtACVfeFL8nOMD+BYNyXzkWSbiBq8qiavXO5rxlW0W7mFWpg66D5Fy52wwBLqc/FaGyleGiulloRFldJrF4AFhNdS7dnMpRfq9t/8Hq7kPfUXB3iLytIsrAywLuy6prQL+kh1U4sAYG7R+VgkeqhJIwfsShUl/J0VwdYBJKKLcs0AYv8rcZccNgm6M4hiUR+uZYhhHJMCyGrD3ZX6yh4a2lGD6/eCHOXhyLp0+eHvYF/oRTUSGQtsHMwprqtwSQc6g4BR6wFRtie0+NWdW/cwZYLG/DrnwRzmDZ6xbjXlp0gevMt85fHvX2/veuskjGcjuPMjaVcazofmGYVgzM8PydeApGUVxeHDOgNO+MslebfyJ0YFhcNbLqtLXBXnSCBe2285QqqXd4Z7GW/Tk4PNiT++qxenL4+Ifd3d29g0M52m1Dgc6qlywyb0ikb0YnLUU4l7014DJ2EQmgsOSOkpdWq69XooHPdK2O64T5DgAcKt6KV3st8we6fDOEC8bLg2IRNrnzFf+5nvyuJr3eo7YA8cUlxDB0h5GWOBSKKCqVfr4g8qJY5/cCDWWrr/98fZBbdakuBMp6axVbt0r4Ed7eIlIMG3BtIlp7qryFwws0iH22bVLT6uf/TEljC4MlBJWSfu2D4O5uF79RZ095nAUBeuop3ctjdINkD/iLAerURxLtfZzR3TP/TJ1j4B71i6z6jQLVCE4lSZQcg7TjEeDrag9D6+sMmjFZOdrVdVgcKezs3kHeIRGlFDxzbNyG/Y1G77C0MQ7WHPw/Zs2ZshVhvNYaR1nYZtDhmt9G8a/FoBw3SNdMYIxpmgaPuICeJdRp9+GucxTrnxS+/Ij132dKJio5Agmkd3DXcoK3D5367SDyY2ZRsB1YGbIDfzxy0Nnh36XcwYCrV9iRnbvGr0nec7p04/6ZyhM1i+wmOrZVu+jB9uGznox1X0MmGaZ9He3c7Hdw8c0eWTnJr9wcZAx/7KD0seQQx350vjmfyqIFv2F/OpNZ3Cl+PPPIKnHeHNRIvk+HBB1DVcdaAssnIXBLwCba9d9qdH4TPI2YIY5iRGZ/rD/l+N7feI3iN7EFGsI4tjSRmrEWsfTUdleo/qTfIDsQduA/5qBfyJEeLO6fv1FYXpWIu86I/nqRO7pX7y/aeyOfYBFwtkWClseU7JqpQF5dhCg4SNpJ7p8GlLEKHh19Yw3q8Vn586LPc01xfJ9M+UUUmHAv+zIEe3Du7zQoCsTFFxHUpWnpFwPUO/O5n7vZVN/oll/UDE9N7gu61plwq82c317QHY5d345W7g9L2GV7mi27nJ3IyzuDa72+Niktm3Kr3ba2gzZvja1XDz/UWkpX7xUtq4df09p5T8axaLJc9mtJrm7KL/jFo1obZaUTsdY02OzaK9rzFv7QTaN9rvQ/tX6OhdJg+6SKzqIiE68MX9Ln4eqqWNQu4WwwKOZbCMp3oO3dmPdOZxHa3AUjd4N366jcBbjVTq0yuDAnXo62tIpTBTdWMYMtlODiImIFAMdfAlFDoeUKugjdVckg2zAgaiX9uBCF0cQ+5I83b4udN73FV8Hp2ioq6l28177nJLt3T19uMo7yiNF2PhAWHYdzw8u/FdFBafX0j+VbdUdQPtyKzopBYuu///O/trl14PxW+dpMG99D1wQaF7gh7lpVCdU+MkMghmDcM9iXoEBe7N1EOs/Ry3iIoryCJnC6ryfYnwxJItiglJteIuwkiiOfa7hREE00ItlVCAQYe4kwRvqWIzTqhDsjGAsjAIkIRDPRTOZGEMJu+soJ8v22NWeSWfQ59Y8JShxzJGGArUdhyD91Dp4TvIQqL58g/pJwdmLf4Xxvb2/7kj7ug+Tu2LFm5/Xw+Pnb8+c9HHNfXomU54BhWA7gyQO10tOjWvYf9ff4+6xMCqurrId/eL0Nqml8lUaRifxNf1Pehlap+pTuxIHUYeW7kTii/2B/ad5qeK+62UHzN+JBeacR3t1/6NzdYekAnMr9Pb4N0VpCaQawGIIPNi4Y+MPK4bXvrk9XGbh1ZpO1bbHwZ+yd28kD9pAiOQyv2QZfq3nzwgO2QFdrNhjFBfJTx7yMHlnakkoru8Q8hEdgHBynS5+tJlGnlxhKjyCcxV3PKJHsJPIW4x74/6Bz1aH7kigubk/p/TsIDMJJJtFSdpjsvS1U1pOVa0pW7IsKnKzOlmbewnvB/1fgQfUh/0A1gvThn8Xj/MnCAUWkz0/jIeGV5v8AHqEUNQ==
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: eJztWNtu3DYQ/RVCTwmwF3uTNMEiCOrYSeE2CILYRh9iA+ZKsxJjLcmQlNfbxb71S/pp/ZLOUNRtJSfOW1DEBhYSxZk5cx9yGyVgYyO0E0pG8+g8E5aBTLQS0rFCJ9yBZVwyuBPWCZkyXOGMO2fEonDAElgKCQkTkvHwLTUAK5Buwk6XgUUyYi4Dxq1VsaD3va3MwK2wCIGheCFj41dxGy+cWnEnYp7nm0k0ipQGwwnsaYJwYyWXIr3wMk6Q41GFC3dqbvgKHBgbzT9t9/S8kOJLAez0hKklqacWnyF2SCXoq+Yuw2eJ9PiWtBmj2FFk4EshDCACZwoYRTbOYMWj+TZyG00kFnfLNNrtrsrNYN1rlWxoB0J2qBs9cq1z1IwgTT9bwrVtsdKGdHUCLL11QLQk1cC7+p10vGQZSeXoI6shFssg1JLycMdjl2/YOuOOrB+rPEeOkJC178ZSubGQYxK/4BYlLnluoW2CT6WdughQ7y5+kfTNM4qWyqB3cQWfEchK5/T5l2dPnx/OZjN4ET+PnywWT+JZ/OLZweE3tERvRrvKaw+V9b6PvVwk2/iYrdiPGHLA4LSOyxjYpRd0GTFcvIx4io8kvcPooSDeFnnOZEuokIm4FUnB877OzVsPIgGwIK1wSO02LQALpXLg8j4EwaldSWcNJ5LUTXwShVEEqTKbhyv6AbNRyQGtjgOrYUE2Vvo7fGqAJz0JZ8SDVWHrfbkvCP+6gd1NOozpbtJVBFZjLpVhPjs4+JnkP5P8Z5L/2Eney+NvBF2YYpgt4hisXaIrNyg8Qwx+vtgSh6dl7ncZLTjNRrpwrJ5HBggPv6totNMSjFHmWCUU3/75pJug+xWkm7ANdWN3HPwg9ShrY6NmuwH2A75q/PN6QPHdbsDUFxKHvEwZ8RckPdM8+856+v8yzSnKM5hJzIK5BcO8mD0b+WoQF8aXApxzj7T4A+jxajfaRq+BGzBHaGC/QlrzlAbiMsI7zQ2BZIqmakTm52ciiqbljD2lPBrXA7sN7xX9dLs3Je8iwkWoh8bvE1ipoBTuK0yOa5lz2s6n0wS/jbkWE5EajqcIoaa3s4iU2ct11IQOJPewseXnAU5XjcXOKHBKf1d2qx3Hy4VwJChN3hwKjkLM+kDs1aGjD6fsBjZ0fMnQWiFeJ+wcC/ktz4u6B1x3+FyzUgxbFdaxBTBt8Hh1h4VnLVyGmz0kds0eYccGz8AZLnJvBs1jeDxiMEkne2znLBC+3KjCkEXGCO7V9YTKbjtCttHCv72tKu7vf573dfMlkDl1AxID2NoKXskpYKYDYQcEqy3os9X3K08Q1ZlIrosooCmvPzbHpjdV5gxMSDRyfG2WCO4anAC+3pE7PTb0zqYZtrtc6FxlSyL8Qi5VVbZw8PLlZIV+onJQaK2M+7UOyQaj+K1Z6sZys7lXImoi9ujfv/95TMMdZ2drSITNyt4Hd3HGZYoThEwYZko9GfrMETFFmUKtweCBHc/8OMnil3w5tgp3g0jxUJ5QELvNKNDzRQ4MD+l+GS0zorO/SIXDUrXGkzo4L8yqXCRMq4Q5iDOpcpViccUQlciAYpYzCWuWwy3k5AIqr74G8wXGNA4kxKS6AcDtscIwEH4w8wHn1TOQFnmYdP0lhG/OSJYgHMK54lKibmhU7BvoUx82VRZj0qDfZ5ODns3X6/WE+88TZdJpoLXTd6fHb96fvRkTDU0SwuUd5zHK/UTFBZXJqjpQGSz9NTuYPZ08mRwSrVbWIboWnvImY39m6Q2cdTv88e9rQmo7uHNTnePphBT3lt6GDvMp3OKQmt0eU6+0LDHfv43Bap6hHYnPdkunlwuT73a0jPXD+EaI9ufGB23ZioSl52R4Im5b99HHME48ZvdeGA0qWLUQSf3DF/xyfL2hDtO7UNphq64aDAEsdx2XMMbnxKvh0pt/qDOWFFSZtfvq3nab/3BBxX0R7qVWftSJDF/TBRf+zqNL/PdXbj67/HhF69sox3pS4GkI95Rsqejx0EKa9nnj22d4IMUGzbLfSUtd6Jc0GyR5STmGDe1Vvb38ci9B3XvK3eSkKwT9Hx44SCw=
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: eJztWd1u4zYWfhVCVwng2Ek2k2KDomj+ZuFtMRNMEuzFTIDQEm2xkUiVpOLxGrrrk/TR+iT9Dinrx1ZmOje92A0GyEj0OYeH53znj1pHibCxkYWTWkVn0V0qLRMqKbRUjuG5tCJhTrMyKbjDI1dMqkQ+y6TkGZtrQyvaLLiSlpMQloi5VKCUirlUsFgrKyBrVsoskWrBZpmOn8bRKNKFMJ5lmmBn0M3l4r5IsM202QFkBTc8F04YG519XG/pe6/kr6Vg0yum516T2S8iduCS9CtUTvGswI+3Vm9sOIqM+LWURmBvZ0oximycipxHZ+vIrQqit85A36iqHgKxsO5CJyuigLIOh6JHXhSZjP05Jr9YUmrdEVUYOqWTwtJbq4HnzLL3c3+mesNGeSddRgs9O/QPfpuCXS+zFct1IjJLh2/J2TKVccpyvmJGzIURKhbM6lzAK9ZxeoN7wCI+w7AKDHZlncjZnhELiYMHV4bFEZuXKqYF0E2v8KpLlfBmgQkX74/ZeU+BZh/4xRGovJqEKKUdAWomWI6d+JNQbCldyjgrgzMVd6XxIjbSxmwawFgQJ6GqVlcvlTC0lohYJjhUvZkRsTYJg+lz6bA3nETQAyEfEA9DJBMgGdycWRBmonsUo5cshq0ghSRY8SyIfwNsvjBC5HiyBOrPBzjfgVQHMBCfcQs3znlmga8tKCS7SBtFiKecA1YRnsVnnhceBqcnb06O+LE4Fd+9Of3n4eHh0cmbODk93QHFHSxTbkVE/yDjqCLJwenTb9ABecD8WL+OY53v7P2hwRlZGUZI4ZkuUiZbKAoQhbMy+SSA45vptK/cnVfsryqIgJO7YXK9wTfsQXKYLYCUuRQGgGVB5Ji9JedvAPspiPoUIa3hZQvsn6Ixu4RZAV+fGhFGGTKWYTC6gW+9gQFFhRhe3RgN0wvzLYYecjafHR0POBu2i3WZJaQMVHr70whZ1vmkrIDZpWCJ9uGW8mdQNGEAYGw0ZEWtokWMXV1c+JThyXNtBKtzZI3uqqpGfyVZweiG216K/RiS8KhxU5FqJaKH7bAIqXrXVv2jvwNVSCyiE8be8jwfNnZfwKURcBqlHMCafPgkVnGm+ROlAmbp/CT7USaPjFv8T2IfPTy9/l/d4JrIYFFiCUf9KsuNJyP60qbvtANKQ1m508iRX+e/Es/SRx9l1EHjJJ7ipbAalgaivfe3+wMCYQtV5uRa2MxoSTVVahs9YCdC2kuw396HugXrhQcuYHNIfV+G+7znm3rv6Sm6p12GPv46siCoD+KqCtS2oJzugXh8ePha6F8L/Wuhfy30r4X+tdC/Fvq/s9BTNd6p0NsCO/mu9LcG8GcZx8LaeZllKyiQCp74a4M1cZ+Eit4XMuMU2QWCqblmGGA8+qZWoBsMwhhtLlERyYr0fNXZfqcP2Q6Slrs1r4QWC69lk0pwsmpA/IBL2uxzMXDwqhow873ipUu1kf8VyYBpTv6PTfNBWF0aBA+lXl8+dgz05hvbyP8tA03VpukUBr0U89ts2QhMVsSlQY3yLfJ5IX8S9PhANehCcCPMORDoV+jUfEEXgd2WGatQItV0jQit/J0hMUSTcKk4adPLZN29Bawi2pxUG7pbvBK5rjUHXWlQDaLUucKeTSYJfjvghRzLheHKjaWePB9HpPFW9w51qRK/IMaGnwckPbRmuSV0BKdujNN4h4eF+r4z2LW98TyvI9ejbScjn99MqRwyim9qEgIox4yay2eelU3lfezJeWRhG5aX1lFHUmDykJ+Rfn13/xh0ZI9sD2ERyiu6BJl5MxQ8FvsjJsZoxvpiz1jN+P0KQUUWOYByPzz6PqsLg3U0829vN13Vv/9zt3s2XwjqGllwazfqBUm1ztQQ9JRgjQV9SJINw2ZRE27kOj9cUvB+aK+FrzfhsT390QDwpc6+26QPdd/bfXLTWQ01n1/qKmtQNAFdt1CdCA8tT7tQNzSdheGOpVvz286j0y60bUJ7q06YnetNduSxz46NCmVRaON+bIKic43/r3apH00t8U4mapjY3h+//b5P0whnt0uRSJsymuAwIMcpVwvhG0PEanNGH7vUIm06aD+kwlEWv2TzA6tBLeRCNb32qObnM8yXMbI5LWM2HGHPRC6ko7kdU71woQvVGTqhQifMiThVOtML5HAEiYIAihqMsmLJMoyjmW/pKav6jyczRBVaexKCINYIByIHbFBi/IjjIe+Ph3G/zPx5rL8RYL5JAlsCdUjPnCuM2DTZojwJZUXbpSPtcIQDOx4f7th8uVyOuf95rM1iUvPayc/Ty+t3t9cHxFO1s0PrB8o+iY5LGjk2+YkScfDX8eHxyfgf4yPfJmvroF1Hn/CVqN+jJv3q1VTcv/WTVp0jHGJ2UmQcSbmqDbaua9LH+kOXT9kd9c96X6eQ/VOcmsjXa7pcuDdZVdEyTZ++OsJa3HiIhdIFXfGcNLcQL9pj70PdY+yzF7+eDZ5jU3IU1RtfIMJI+0QVqf91raLZoM6lpF0guQw6HPj00IrY6YiojAYOSuOF+yJtt/jf3FMlmNUf6XLf/ESGL2lCxd+z6BP++S+PPhB8w0Xr6yhD6Jd8QfRBLOUnXtebttY++VpbP3Qu9Po22S674Sz0tzNW91m+p3BA9fuhIQ+/vMjQFKqN9cnmVfUnsYNVAw==
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: eJztWltv2zgW/iuEXiYZ2PIlt04wGGya9JJO0Qa57ADbFCgtUTYbWdSQVByP4bf5JfvT9pfsd0jJki2nm6L7srPNQyBL5DmH5/Kdi7QIYmEiLXMrVRYcB9cTaZjI4lzJzDJcF0bEzCpW5DG3gvEsZuJBGiuzMcMdznKVymgesnNbrjHMTkS9iHZoYQud+Qd+UczuhTbgyWSWqJDd0F23vEmVxQrkMmUZTxIR2Q3WfKyFmIrMmjDoBCoXmtMxzmMcJFJZIseOrLhwxLAk55pPhQXn4PjDYuPoN5n8vRDs/IypBFIzNfoMltgl6WnO7QTXGfbTL0cRjDqBFr8XUgvwtLoQncBEEzHlwfEisPOc1hqrIXGwXH70i4Wxz1U8pxUQ0kJ8uuR5DpJO/t5nQwItGqRyTaezUhj3y5+nZrES1Uqb0o3VidePeFLpdaygfhjEqxEWOsPFSaVO2MSZSgueTitt6DHPpHEC4iF3zqFFIrT3D27YbeDI0aG0SlOhbwO28+rs4nLXsVCzTGii5ndlEdnxZM2ED13YuiuzLhEacYOjJDw1oqnlD94GnaDQaQCVrqtGxm3Nd4JE6SmHmgNciwc+zZ2SDg/2jwbD4VA8i46ivdFoLxpGR0f9QUttwbIy/FNJn4mEF6lt+nKL6jtQJHWQpssl4FOGxdNZDcJ+2G8R/3sZXWv02Y60LIIxE5hHzdwTI6ZgyTztXZKA9Ppk7hNrc3Pc65V3wkhNe7mW9zyadx8594UAoYzc7ObyLYMjzSYymkAYOBREma+QoZTd+7KTe+R8Mu4wM1FFGjtkwD1Op/FuGE14NoZa6UxWwmQ40OdCSxPLyH6VXl/ctCR/0yS0JGCIC1CZXyH4lH466deIKzuJuBYtFuclSdjF0QQX8qFLQTiBJVCeVPEZn5sGO0C1GAv9GL+9w4NNNhTuhMqeKMsdVQr7mCiD6VioseY5LHMp6DTfrrxXK4pgXJMEL4OD8rF4qzz8fROXK0+LpRUx0Idn6fiCazunY19NuCNacxkplQqePcbGw3orTeqY5UTTx7gpqS7xt45WZRQAqdbBulppcpUZD17Dfv97VvieFb5nhe9Z4XtW+ItlBQKre7kRxC2EvqzWtDH6x7EAUsroR1YRYlMVixQhkKO7KtsugyU8ldS0lWnEeKiG77i88YNhBiKliBk1C5nr96TbmzFTOHkoYga7LNLz3K6sY+Q448THofYQ4F3Eklqx8Da7zU6MjAVLtJo6KW4DU0SRMEYR2kcqLaZZh/Fa8jJSEaWQkvZSvoB17kT8dMSX1H75U73z4O/16doyf0mmpUXQyh9Qyx8ivsp4Du62vOtvvuZm4qwwhQ/CwP/9DHJ4uCWDVNZGz+k8vj7Kk3nFzQzdBlVSuCpMOieTOPKwx6iwhOzMimiSobpICT5RXJimWYCeMMltQ6hbxzkrpqT7Tb41qjcfXIpI6Tj4uGyY5pvU+Gz/p2HrlNeUDn6tEoMqfZiKkRnqjzoiguWaWzxZkEUYhsutXJu85CYrihgR/yYtlGrft4//HwCmdPhWIqBy0AU7eFZKdQdNRYK8l/LsjiB7i8sjpSLIYdmoSP2wZT0CwprelM8JDQyNKzIL94FLJNK5hMxCd7otIfWNGq3CAUwceu4QiuFgb67ev9ulC84ozYbsBFXx3N1mpzxTzochjEtaV+SvglYjetn5i+uX7PLlKXt29OwgZDSkIljkEs4OD3cOk0iRxqZyH+/vTDxEIrfQgUexc6ou1pTV/F0pAFBYqaaBK0/WCh+MhtFevC8OksMvXbcUR2xI/m0237l6fdIduBKuhrcnizTsD/e7/UF3cHA96B/v9Y/7/X+0I6GiSzI4H6twnnxsgh4GmSt2E8IaYM6v3rNnAEV2c33K3GixKsx4gYjRdIjnc/L3exkXPPWh044G/5QQtLNxpg1S72Fd/VX4s3+wP+BDcSiODg5/6vf7g/0DPuq3q+rLsnMRruPJGI+nCMDCULFJUTqBM0aAWJp6unp2VQmQs1SJ0ov20E3uui6vr1cDmyJvKCJZJ0xglCkkVFS92rl1SqBhVws6vt0igSUqhJUQJFGO9Cr8z6/z36d5b7TXdiBQELqLGkYaKlkYKiiZcCCrqyjyMotBZkonHYRwLqFL93Aj2Nblv6qKlqcfoikqUOobZWU7M8Filf1g2V2G3kqWjdfGKpenXLpAR039y245HmiNDLaW7GUfV03WS2smRZpSRp6gN3IT7wVt3/czhnUqI064nqMuWE3It2wcfNVwolmpCa2VPoVXk6rp+qzBvjUZ2ay96t3bmpuV6XCy5RbyWyxfW/v5loMvl1v0fJPVWLJFNfv/x6pBK6gKDfSjvjtRRdZW0MFXDrb+Wgo6Bz+dIUkBq2gC4dhs6MiVDVGhpZ27V1MnufxV0CVq50XwXHAt9Ak80N2hU/MxvcPy8X+xGjFCiomi118Qi3RBL62Og55/GdbzONFbVG+vlr4Jut/+PuxMTFUpcjlXqwc7MZ51eS5Dif4ws6FUvfthQKJuNt58XBaa28gY/3gLpY+1PnxF56xZaWVlFu5vlO/ovEKD1Vu6kzJkfc/faqkvztmdmDMKbJp4eG+klliwe54WqzHcpzU6n5hnw6aFcXMmgHkiH4C7M5T6WOxEYp/YDuJBOAJWc5k6NeQ8ErsdJsJxuEH2mJUbf54jmkgjXQj3yydXbDftvwhG7tfLKn29+e26fTaXAZDe71CN5dyYSjxPqZSZ+oQ1IdhKgy4WXVJ3G+oKhEwXkLtS1F7WrzNfVHHRHERT1/ylgWppp+1z0dXMczXMXHeeLw4X16d7fia0OZjbmLg9NlBzg7JHJl+ecGtU5W8/MmGiydHSzQkTVaEi6geHVlM4CqFNkedK27+tYqLWlXxV31rXR724hUCrTWznX3/+c5fKQ86uZiKWaByc1tHv+BkpTXegeZmU8eBCV0bk5uqeBjX+Tb8R1O6mSdfQUFWgdmF4CN3Zeafcz0epoLrX3UYz23H921haIOGMxgvWMTMwWQyrx34eoVI1BnYjRjIQ8F8EZGKG7vZepBSRhN4O4vkIQWXnjghiWE19Twt3QGrhVI47j4/9UHPsel4acsDpOXPFkZ9hOTmnPMtwNigVDiQy4xy5ghFELaJ4uMUHZ7NZyN3jUOlxr9xrem/PT1+8u3rRpT3LerxX24HAJ1ZRQVOSCp5qh6e2K9wLB66cVcZCuoY8/qOGL71FaKTa/+UvOkrIseLB9vIUTXvjRYRPbR/K7zyaE6jj1ccZSCITaI+WLRY0RrzR6XJJtwFb2mVXaB1hSS7gM6A0dB1vH7801bpzWdYou+zRD0e2yl9lrsxhHOUZ34LcUWKrPyxZ0tCshGOSzD8+9fy710Sk3t6qpigT+x2UCXL7xbXNuuHihpLJqPw+ZeoKp0DzGW7S/+PgNnBzQOVU4pKyu78IUsBHARTEGk92WTbg6+n6zqXr8oIOtlUfm5nbn4X+08m2bvmZQgoJ9JfVcv/k0Q2rXOdXk3U+Quh/A4qEyPw=
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: eJztW+ty2zYWfhWMfrUdXWzn0tTb6axrp43bpM7ETrPbNhNBJCShpgguQdpWPfq3T7KPtk+y3zkAeJGo2Enb/VMlM4lIHhyc+43gbS9WWa4iWai4dziViVV93LJRrrNCm7R32LuYaytUGmdGp4UosxiwVkhxrSZzYy6H4mKuRK7+VSpbiImJl7jIEhkBqMCTTC4TI2Px+tXzPt+ITFooYCqWmXJ3bDmhDScqFuoKj6y7HWsrJwluThM585AqylUhLtVSyDTmW+fnz8WVyvVUgwlQzNDCTPlhi8YGJWJRglhbyLwQ17qYi/G8KLLD0WgsTO4uLF31eZvUCANseUAXsJt8JlMQydtGMhWlVUIXQ3EeGBKFgaQWOtWLckHL9h2HzPzwl/SXlKWrSZ7TMkmC6BaA6WPfAvczEKll4iUP5NAFYcmXYqpVEgts7i4jmSQeKYkqv9KRgqxU5jQx1vHYiXEMyk+rCwseJ+bmjO9Vch0XegGNykU2DvzawuRQR0uoTTD8t3RbQUtOKvQUJPX6PZOpnO+dwtB6MIKpnr1mlt44fIABq3KhCpXb3uHPtxt2qMTpyZpmScBeMFivbkBHogD8+Incnx5ED+KH6tH0sfx88iT6It5T+wDShCyTxRy/U2yHK48MlPV7ZMk6J28o8hLOYKO5Wsje4W2PdAZgW+Q6nfVWeFQseTOreddVf53kM/4hk6F4nWo4iNAxFAtThS0FmTrht22JmIIpTWGLBdmH966heDNXqViaEtplNeHZXMlY5cE9nM7zMnV6qIQudFo7300Rdif+404aCKEsYJlwgZnUKdyFxQ4TU345HndS71ymaK1b4Gdrcdt7huK5kleK7zuGhCmLIIc1BBsmDmOLbVMacIlkKa6DsGQJDJA7RTnn7lJMlMwBKCPEKaw1lyptiLdjRSqOXp5S5GmLupCXPtB1ymKamwU/9YtZOHqWwpFaFMOZDKnN7zMgUHJn0pvcoqCJ9q5KwBDVViJchHv5+kKMrg5GzvVGMkZYGslMY/XoFv9/r5an8WrkMQyAYSxIf6CPJT7+xwBxzamAAoV2bNf5g63JabfJV0NYZH06LYl1w6LPYGEIdBPomtC3AtE1Nhd6Wpv7BEHYo7W1DXQxzNFd3WgL3Px7ohKTzmhXYMs3zdUDETOJWap4KI4QzdPL1FynDaeldLDmw93KCc7DfhCQumTSxsBwjjonFGS96VTllCPaVMIWFrA158V0NZU6cap9dnHxUjzc2xuG6OaEVMe3tmhbQc6n/PdEuWZQffKF2pcPo0eTg+mDvb29ffkg/nx/r7d661AiRn2NAoDQ+CxPP2WWJT45j361FBhvG/tlOQWpQitLVz4S87IkOZtyHqip/bnnk/jrPAEbfpMLIhk8VGXEU64i6BbXC7DsHij0nJnJryoq8LDQBbN1TMlKneXr2Wgz/YSk41yozKtozfmOQlojH7UsP7i8y8FV/u3Ivc2E2rR+6H0xFKdFI+J0R5qxu/2bT7bj4ImUX1uybohyQ+9d3JOZnROPbG9URbH1wvuVvvIkBQl53E4IVzJB7rtnydXyx9KlTZcI11JGK9+H5f7OMDKLERFiR3qWS9jhqm0t92K4Wamu1x0Vg98Q9U0TvxlcX18PQPJiUOaJSiMTq1BrfXd+9kNVhyI8WELvQjyISJjThS/rXG4ee+gx85uWC3KCDY/q9+6koPd21eEitRw23KLDnTZFVFez1llDU0bBMvrE4gMxy02ZWYTWdkHsBftAyDyn+pF1PzeQwPbKWbTT/xRVgqXIWoO0IrAvfhIkBEKlC+uIaeOJjXLguVoYFCNx6UTqDdhuehAMhDT4QqZyxjX7mzp8ebEyUxuiO3YLEdHDyqYkmSzrhWuFiSLkLK5mKHmksb7ScYmOYMZuB/sLEvD09OmetJecUWKFfI1GK0YqY7PDMxehSCY6F/gpOXMUamHvdozztWatYZaMyUc/KA5dC3WV/dZ9tEmRQgkRu/BN5A4R6c116w61fhs3UZSZd+om0/kyIHXMbW4WmO144lY0yWivqJ+8XcFjYj3ThUzecNlzX/WeuEWh4G2p9im3amenJw9/PPZPWHdcNLFV/s2H8UylOh5+NvbmB/9w2Z+LW3+PrRxW4fCdknLPsI6uXsJUCjXzSSpVKra+ZfM8+Wq63qCuknibhCrpk9OTY7NYCBh+YSJT95eBPqQ+LmfQ5QCTN9mpIe0xGm1tCTwWRQ/XSzWt6iaay3TmvTngm/O+d6J1YIy2vR7VKFmLyxGfDa8erK8mCioRBRoOxdgXMO9oNaXmcO2jWEjPTfzvZHRJD5BtVJ2A3TTCE9fvWIXdY7jWvRE2eeVe+ve76qbyDJWdzLxr1jsfB1l0gtQ/37HS74RiZu8Gojbhbjjn2N1gRA65NYBSvQWGW8ANwjetsbGl1+M9ode4vQN2nemWWTdNFRZ+B1RQ2nbITRO8J6yXAEG7aIlQ+kLml6rgMda94yWWIRdW6+6XDJttuCvAbZ3caKJG1NAUMUqMLRE85SxXLtlCJCaP/7is16B9SNfv6l3fVbu+c7uSpFxmcePNxuYTYxIl043deS4xpnmUryNDhdUoWVjHXnDwBU1RiKRXz6BO1FSWScFVwZj7Pi4qY3fbt4KrZtN0t1jqeSySWMytkFlkpSsuqKc//ZbK78E5GiBZQBxj8ezF0fHg/NnRwaPHYVxD9b2S0TwQvgxDZWYqdwlS8zwIfWN0ycirGY0ulqGIrKryE8NioemR9P0HQGzGY2lKoIct83H+xnvQLIIQc9dFwkXc9bRXnRQJ6VJn5zb5sTF5/hhFEgFgsNIj544lP7p4fi4iqjWnrghts0j914crd0Wd+mYVn6rr7t4WrK76rf47NOgb/bSz6Q9BvT5r5Z1sRtUee+TB3t6fOUnQHF39QOTDxgqV6zadpdsmqJ/y/fz7ZhDbpg5HW2YOnTPUZjND5d3SeiNuvS3w8zlHQp8qIBrDtScRm62Oju+OBluH3OGNwf1G9Kuglo/fcHMWh/LetmkhJ25OxT5+t64JYFsbTg0s9/DOBjU8hT1Zv8nYGAUGvG6ASCmEmuf17trhKuZ1inQdLo0ubQQdMqsfMuy532jnz52/HN9j9rKbiOwmIruJyG4ispuI7CYiu4nIbiKym4jsJiJVyYrGvTUMWbqK/6NmG1UdF4Tr8pOhF/FRmcj3jTvCiZRp14Sjoz9wwwrUZxEYzwWf1tHhhFfNpeuT+8IaTkQoVJmE8ADFDr86bj4DJ3/06KJVJH7Y7IIoqVvju3uSi2M+TLbN0OOmFXB5Pf4n/gxevBicnFzM54eLxaG1P435DassttS5LvU1FcEHRDqPmB3sHTwe7D0Z7H1xsb93uL9/uH/wU2/bhCUoTk4L5d5lB5S/Z8By9j0o8idiIEICePiBQ5Pm1irPTX6M1oj4pN8njd06hhft0r9eXSuT6y0+iVLJDQSuOtB3GEAt6q/pbXmalYWoTgiSODYFQoDVYbmgYSoUav/inelkBcXXFDow1WgETxdId9i9TwBrFltbyX3OjfIG9VmeoH9f2NLMYLF2NjYc9mieHa2CmDss6wlvdXU8Q2idVPAtHuxXc0BfN5D9v7CBvE5pbGxy/RuXEuuiefgXFs0rZU2ZIxqS8UxNmfrTO61Z2lxyZg3mzD5A5kyNdypOT9hGm/kYxujr0E1TfPSXjlWn2C9P0RP7GMXbrMnIVSxlroslz6+P+Jgmfr6lw8Zf8xnWIxg03yGu5YyOTlfjZNwCBXNDR65BEg+6CboXToF6NY1uqyPQKx5qE0Vdh7BP1MJ4ggFX0jSxmv3FeDaQmR66kd9Qm9HVQcep6HNQCaltQ2Pd4w5Mb2tpnJNROF0GmdQVtbux5Szkkff/MJ5fm7eHY7r1AeBqmFu9RuJar4WnKvPCwTX0BFN9Q4flOUs4GsVYfALncsVikUudsBjopdSnfaGGs+Ea2kPhF35Jx1ZJInQw+KsxF09N7d/23Hnmb7i4AR/fvbnY5K1x1hnGaW0gz2HyNFPp1CJCVBJkT+QakRf0Ki8j1XEhQz77qj4I+jR4Ret1THMUfffgeG1u3DXp7Zrhbh9EbpvKvd022rpjNvB2e5P3Ua1Qsw8Kp3PrrqUOOZ1lvH/NR7Y/NSG4yoiDK6KoTniMnWUmL/5eOVftHPrb+lbbK2vgjUBWLRKf/Pff//nUfc1yfq3Axtx1nGGmxOOd1sc6oQJHeL7SfF781E//rEqmA2sArdBM+bcuxbLv15OARK0Q+kxBxO0hI21mDYogkRm0ByqapyYxM03jd5UCAXmf5DeUCQqqhAfhFJT5q4kJvLNw5/VpzAq3InB6u51ompw412H2cjWjJhD8WHeYkz7loRgSgxyiE4Vm6k7gwnQVDJPUEeIR3B/h4GC4tyHz6+vroeTHQyThkV9rR89Pj5/+cP50QGtW9euJWg8UxWITlYswlgBqCuhOX2hcHg4fDPlFW2ZsAeoa9LhT0CF/rweRRrbefRi2+zDsj/gwzOcQGnSMwCOS9so7wq2vVn72n4sBuDbLw/qjLUTgOeyYAG9vJ9IqpJbVim7D9nIul2D/Mueg4Yqa9Qi71cg/eeWLzk/FPT5A6+QllCUp1SRcROAKPy85ntdsrCj2+2T7YUTuvjPbfWe2+85s953Z//E7s85I5yLaxtdmVcyjXtDB+OMdA3/GKkBsFPf1iiNW43thm90urBCwE/812oJb/V4ur+nUGf497P2Cv/xCh+s2Hi/Q/dtegkq1RNMAGIeWymnp26y6xbzkFtP/oHDdGebXu03HC/1LnHUu+ZJcGE7yVQXunmxdUPVnDppUQS9U/gc4Tsve
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztVstu2zgU/RWCqxawZTfT2QRFMWnaKdIWbYGk6KIIIFq6ltjIpEpScTyGd/Ml82nzJXMuRb+UFINidsUsEkvUffHcx7lrWVLrqFCBSnk6V42nEY584XQbtDXyVF7V2gsyZWu1CaLRPngRahKtWjVWlaKwJhC+hFVL/EUFocSSZrW1N6JQRnSeMvHJk7AGf3NWxsutajrIaxON5cnKFYzkYq6pKcWyJiNWthOFI8QnrBNdW/LTzn4mrqDsyd2SE60dhqY8RN9cfngvZrZciTks5KptG4374nKTr96aPBO/D8/vxsvlcgzxxbhzDZnCllTmo2g7OVuoG2LrPjhtqnStvWNTpnB06KNgY6IzJVTjfZNkLm5olYn3Frfi80K1OqhG5Of5DprzPTQ+F458aw0AjCD1AFjHdlMMCdiiVqbC74zCkgBkoZrGZ3IkbUsuXvMCGZcVhc89lh/7iA69QXrrzsvTtTyZTvkn5Yofh2jymS9qWih+ah07C7rXPrKM92GZ/WBJITi6U4u2IXn65X4gI/mvGZXXI6kDLR6I5uzBWKJP0y3+i0O2Awd93cjN7kA5p1Zys2HIv3XacT9+OcZsr21nX6kIkN4Mu/XDWwRSk0JB8LVY4On0yQ9l7dA/OWfdOWLnm/PzywNv9+IZDTK+18ZLEsUQoYrcYfaeTqebB8zvdRJYByryBVKjTdsFJMqpBQWY3GweAOSTUV2ordN/4EZDaH79wYL+uaC5gD9nMG3STItuBhhByVPROR1WuPRanrX6LfHj9Wa0li9IOXJnADie8K1V5RmdNFQYCERQ2zRrGAfF0nIC0Oe6mqS29pPUcJOUjHFIE6gPzkfvx/G/pIVNsUMObYazOoTWn04mJb6NMUwzXTllQqbt5PZEcszHNi4RMA/w75jx/ecHLF3vgbnk+ujTuoVnlx/VH2DQsLceWbwZ5IXHTCrNWG9ymJ+zjxdMD4ILGIiksuxHfpzy25GfH9nJRe9GLDofMP8FCH6u7wiMqkMN4RiSyMUjs6Wd4JRuIgytKujxSFBWZQOzpyIpPgMnO0ZkjOCe5xkPscNCWMtZfAOtLhSaSr75fHX/bkVBHrPd3oCbWuX9NrzeUoqZOfAoCLFDMDYlY9g7k7uG49TFOarN3G67WxWxu9HGmtPru7a1Lvy2S+k+Jfr1/ui4FvbC9zpppyQe/f3nX4+FZsq/XFKpfS2wsihBdz0hx9UAlabnKZ2x8nTBWbK3GnfLxEVggvP40szH3kKadGUEPqIIwmqU9NWsId6N4jE2txF8lrqK+8MSbE8hOvO20byNlCJQURvb2AozCCk2MMA5V8LQUjR0Sw0XFE+hOKrUDDURVtEIStAimSxeWMwZrQxCjgmL13NUdU28T1zpsO90TcOVWyIcjnOhjMHdACrGK2Gh4HRsuwBFhyI8yab3MAeJZip+zqyrJknXT95dnL96f/lqzDrMoTo0R8kT3DulLboFwNl2F4+RPl8n05On2S/ZE9blPQ3RHcTzDjuuAID7leNwHxmW8gF9/L8r/2S7chopge7CpG0UZvgmVeg68dgX2fMYhLdMFjkuRoynYzYDadS4Kqut1zPl6ZNrNhs+/taRi7SKMlUu9nZPslvOYPq7YWqJo7NlJo3RR44Z7CybQ9Z9/Yqnr0qjeU9LN5GW0gNb334yqwPbQ4bqQ+D/zKUPqjzj3gNRPN+J91++q7Cb6b00o3yNzeMfJKskgA==
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><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}>

Access token passed with Bearer prefix in Authorization header

<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>
      

---

# 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: eJztWdtu4zgS/RVCT92AYyfZdAYbDAaTpNMLzwy6g0kG+9AJEFoqW5xIpIak4ngNv+2X7Kftl+wpUpbkS7qn3waLoBuJTVUVi6cup6gsk4xcalXlldHJWXKbKydIZ5VR2ovUkvTkhNRC6Uw9qayWhZgayyvGzqRWTrImHgufk0iNdgTFSa2KTOmZmBQmfRyKYBb/a0eZ8EYYPTHSZoKelfMsB5Oa5vzcumEySExFNlgeZ/AKZqdqdhm8uTaFShcQsfRHTc5fmGyRnC1ZxmNr/iirCjJBffS743MtE5fmVEr+VFk27hU5/tadK2gWxadpcvZ5mfhFRdjZTH6n1GM3r3zBC+NOfrCF3U0OdTMvFqI0GRUBtk5czHOV5qKUC2FpSpZ0SsKZkoCd85K/AUSo0LMnq6HgFs5TKd5YmgGlCEezOBDTWqe8ALnxe3w1tc5kuyDIp2+H4nzDgXYfM0WwEI3gJodFG89RmZAosZN8JC3myudCiloroCy09LUNJtbWhmLsQ0Qr1uTYN+6auSbLaxmlKsOhms0spQYRB/Sl8tgbQeLAQ1DuMQ8gshGSAtpSOAgW1D+KNXORAitYYQuOnoj11+knZ5aoxKeQS88HON+B0gcASE6kQxinsnA02E6FjH82gQfg2BXayPZSIq0SfKZnWVYhDU5P3p0cyWM6pe/enf798PDw6ORdmp2e7iTFLZBpQERYgPxmUuAgw2TFlmPQx9/gAxfLj83XYWrKnb1/bfOMUQYIOSLTz5TRVhbFFEWwCvVIyOPr8XjTudvg2J91EAWndsvkap3fwIPtCFchU6aKLBJWRJND8YGDv07Yu2jqLuE+cZdsJftdMhSXgBXpG/oLyqhAo7ACoFvENgCMVNSo4cW1NYCe7LcAvS/YcnJ0vCfYwC41dZGxM3Dpw88D9EIfWqZGzs5JZCaUWy6fINGWARJj7aGoGhcdauz9xUVoGUG8NJYEtz1l19m9Wq0Gf6ZZAXQrXdM1oY7Tf060LIkP2oSpyo2m5H67LILUHqw2j/4RUrGxUK+MA/Ky3A/2poHY3bnlIK05ho+0SAsjH7kVCMfnZ9sPKnsQ0uE3m30I6Rn8/+oGVywGRFklHvWrKtdBjOVrl380HlkaaeXWoEd+Xf89PalQfdxR94KTBYmXymq/NQi9+XTzdo9BYKHrkkMLzKxBQwP8xiX32Ikz7aW0395nqjRYn41HLeTmPvdXq/ttXTBOzMIgz9U97its5l/PFgxtJvFqFaVdxT09JOLx4eEr0b8S/SvRvxL9K9G/Ev0r0f+liX6Hzrct9JpjfM+A4NdpSs5N66LgG35OkqsDB2Htk0j/m0YmkttAhcqrpEVmohvsUTz6prmhXzlkrbGXoE+GnD+/722/M7RsV1Sn3cVCwYtZ8LLtOzjZao/5PfHrWtXFnoOvVntg/k3L2ufGqn9RtgPNu28cqf6/oBnr9QBGFnOFCNtsYQQlR2lt0a/DuHheqZ+JP95zP74gacmeA+CwwqeWM8fojDdmWziRG36TVRkXsJCskYx4Y5T6aKO0ozcubLddsKVpnIVcbdEMk9z7yp2NRhmeHchKDdXMSu2HyoyejhN2cmt4hYdMRC+YcfHxHkv3HRI3nBAxjms82oDIuIB+xLtFKPEtkkty3uRiSLCdhnR+PWY2EJyxzJExD/n1IYknWdQt8Txs2HkQcRtR1s4zIVcYvNUzGkoYbh+ij+JBvAEhR3YBSaoiwFDJlN4OBA0xi2yaPRON4vcLU1tG5ADO/fAQxox+5JfJJHz7sB4qfvrn7e7ZQmtrKKKSzq3di5Yan5kPN5wQLYKhChnDuFnSVhiHLrRcrtdfu7eiV+uK2L788Pz7pcG2P6PuGz63x8R2sNg3e31pqGqSoq3hZoLoFXVk/G6h4fPewn7C7lNeR7w9tuxYci3KCCo9NeuGKNPQEFsX6qoy1v/YFkXnv/pHt7RZTZ3wTvNplcSb//77P295GJfiZk6ZcrngCwzuh2ku9YzCXIRabc8omrbRDpDhjoZAOTwppgfOQJrUTLej5qDRlxNcr8C2YRlXowH2zNRMeb624lJLPg5hpsAgUJlMeEpzbQozQ9tGkWgY4KqR4W19gdtYESZabqThlf0EVYXJlo2giA3KgcWRNmCVMOGHlA/Hw223LsJ5XLgQi0D7UMvgDvtZSo0bJl/swEikHXVDKtqORDmI4+HhDubz+Xwow+OhsbNRo+tGv4wvrz7eXB2wzqobnbs4cPfJTFrzxL3uT9yIY7yOD49Phn8bHoUpEV0c3vX8aYZa9eJLgx7J/mX+yNL0D496HlWFRMNeNWAuG4b6nDSpFvp5n9FyJjI8Xy75ov2bLVYrXuabWGBHQCdtyLfIlWsmYFJ7ZMJILiMeB6E0WRz9PfDH1gDCFBY1uIVW/ouyfa69/nTDbXjS/IGoDMNGYuWcb0f4eZbc4V/4Y1PIwjDg8PoyKVB3tZyxfLTLzUE2zb4jusdAdM2H3sskqRc9L7c5Lx6Gf/audJsq33Mugnp+aMXjkxcVWpaI0hzKezj9P22bqhc=
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: eJzlWN1u20YWfpUBb9YGZMn2Oi5qFEWd2Cm0LdIgdtCLxIBG5JE4NTnDzgwtqwLv9kn20fok/c4MRYmSjDS32xubGs75/84fV0lGLrWq8sro5Cq5z5UTpLPKKO0FnmtHmfBGWJL4n5NQOlNPKqtl8S+HHzNjS8nEQjqR0Uxp3J8uw1Vj51IrF18rHc5Sox2B9bRWRab0XEwLkz4ORRC8loe7lVVPMl2KTLp8aqTNxCInSzsqOJFKLUppH/mFsmv2biCcmmtQeynk3BKVLJR8OkwGianIBqXGGUwGyUzNP8C+cccXlyppZUmerEuuPq123PRRq99rEuMbYWYCGpjpb5R6UCl+W0mf41mDHr822kLcILH0e60sQbK3NQ0Sl+ZUyuRqlfhlxfedt/BL0jQPfNlVbJHj9+enp/wP+noYw4+yqgqVBlNGvznWbLXFr7JsqFeReqNGoCyKX2bBsFZqZ4FXvuCDnjP61t/lIDeLYilKkxGCAA9sriNQKs0RlCVAM0PMdErCmZLj5rzkX4gvSOgZ3tUgcEvnqRRHluYK1ke8xMOBmNU65QPcG9/gp6l1JrsDDunxUFz3FOjkIDiecRXUZHRp4xnMUxIlJMlH0mKhfC6kqGNEtfS1DSzW3IZiHBOhYkqGX6uuWWiyfJZRqjIY1QqzlBrAFa4vlYdsBIlxjovyAHs4IhsZy9QSmNXzgrZNsWbRQjyId/RETL/Oog7ajnH9fAL7TpQ+YdhPpUMYZ8gRgGwHCtk+3AZJzGSc4JmeZVkFGFxevLo4k+d0Sd+8uvz29PT07OJVml1e7oHiHp6pd9Kib8gwaZhzDPr4K3RATbA/tD+HqSn3ZH/ocMZehhNQKnpIGe2gKEIUwSrUIwHH78fjvnL3QbG/qyASTu2nye0a3/AH8xGuAlJmiiwAKyLLoXjLwV8D9nNk9TlB7cSPHbB/TobiDdwK+K7LZCEhQ8DpFrENDgYUNXJ4+d4auJ7s1zj6ULDl9Oz8QLDhu9TURcbKQKW3Pw1Q0j2cbpFkC7EgkZmQbrl8wo0uDQCMtYao8VFFhxy7ef06lIxwvTSo9G2hbNHdNM3g7xQrON1K16uzn2IlHnRhqnKjKXnYTYtYr/d91Tf9HW7FwrLdiILnZXnY2X0Gb9BKPbuEYc0xfKRlWhj5yKVAOLafeU9UNuGeOglsJwGeQf8vCrjla/Aok0RTv0jyPlzj+7XL3xkPlMa2cm9QI79Mf0NPKmQfV9SDzsnCjZfS6jA3XDr65e74AEP4QtclhxY+s0ZxY1XGJQ+QxEh7Cfa7cnhccYF5pAI2D6mPXgz47aCPEbnDcLveEWSiWiOidZqSc7O6KJZQIcegEYaKFdNfxJ7eZzOVnNsV0qkbQg4Qnn3VMLCdDmStsW/QE9mP/HyzJf5h187dNNlQbxyMYZHmQcuumMCy5gD7A0HZ1J/XBwxvmgOO/qhl7XNj1R+UHXDNxT/YNR/Imdoifbj4hgay56BXXzlI/n85aKzXYydZTFMiiNnxEYgcpbVFlwpD8nWlfiJ+fOAu9JqkJXsNBIYTtlrOeU3YHppxCiVywyvGnIIreC24SkYsF/VttKkwo9X2ktAkLJ11O7R63FBpWtVxr7ZoCEnufeWuRqMM705kpYZqbqX2Q2VGT+cJq7wzwENfbsYvsHHx9QFODxu/3DE8YlTX3unCI+NBuw5Fx24Wous2dQPc9ory9fsxd0TBCc5zQkQlL4gknmRRd8130uMzEVGMKGvneSipsHyoZ9TfMOBPoo5iIo6QF7HDYlBQRXBDJVM6HggaYh7rs70SLeF3S2QVe+QEyn0/CaPWNg5WyTT8erserP7z6/2+baETtG2yks6t1YucWp15JugpIToPhpxkH0ZhSZdvHLqEYcsb+Tq5ZRqSux0bEldXlbH+hy6kWzvqj5ujPhY2l/cSqSMSR3/+93/HPE5LcbegTLk8bt70nOZSzylMNkBaN1aINge6ETBsWRiIHN4UsxNncJt4g18Pi4OWXk6xIKUoRnyM5WYAmZmaK8+LJ9ZS8nGMMgVaeWUy4SnNtSnMHCUIIdZgwDHHLkYLUaBDF2Em5aIQvgtMgQnMpswEEDT8cQPXsXWgQoYZPQQsmId9tS6CPS6stCL0eJBlUIf1LKXGjsirGaoraUebMRNJIxFMcT483fP5YrEYyvB6aOx81NK60c/jN7fv7m5PmKbZDL+bOHDuZCateWZeZxeXkRiv89Pzi+G/h2dhzjPOQ7stffgDSH/Eyvqlt2sX/4yPRG1ieeyEo6qQqGRNG6dVW8k/JS2KQ6HbctxV75MPamYOb/P91Yq38o+2aBo+5rUtNBVESdoA7Vjw4Q48Z936/mIkjj60rflYvPhJ6qAh60KtuUqHshp3wUeu4/1PVg0P1W0FYu3iFS5lld8i3hshmu0O+OMtV0PZlspNm3gMbaJ92Poc1Vdst2NEFfjv1lLYJ/mOcwGF+/vuenzzIkFXY9cuYMOb5i/1yV0p
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: eJztWd1u4zYWfhVCVwng2Ek2k2KDomj+ZuFtMRNMEuzFTIDQEm2xkUiVpOLxGrrrk/TR+iT9Dinrx1ZmOje92A0GyEj0OYeH53znj1pHibCxkYWTWkVn0V0qLRMqKbRUjuG5tCJhTrMyKbjDI1dMqkQ+y6TkGZtrQyvaLLiSlpMQloi5VKCUirlUsFgrKyBrVsoskWrBZpmOn8bRKNKFMJ5lmmBn0M3l4r5IsM202QFkBTc8F04YG519XG/pe6/kr6Vg0yum516T2S8iduCS9CtUTvGswI+3Vm9sOIqM+LWURmBvZ0oximycipxHZ+vIrQqit85A36iqHgKxsO5CJyuigLIOh6JHXhSZjP05Jr9YUmrdEVUYOqWTwtJbq4HnzLL3c3+mesNGeSddRgs9O/QPfpuCXS+zFct1IjJLh2/J2TKVccpyvmJGzIURKhbM6lzAK9ZxeoN7wCI+w7AKDHZlncjZnhELiYMHV4bFEZuXKqYF0E2v8KpLlfBmgQkX74/ZeU+BZh/4xRGovJqEKKUdAWomWI6d+JNQbCldyjgrgzMVd6XxIjbSxmwawFgQJ6GqVlcvlTC0lohYJjhUvZkRsTYJg+lz6bA3nETQAyEfEA9DJBMgGdycWRBmonsUo5cshq0ghSRY8SyIfwNsvjBC5HiyBOrPBzjfgVQHMBCfcQs3znlmga8tKCS7SBtFiKecA1YRnsVnnhceBqcnb06O+LE4Fd+9Of3n4eHh0cmbODk93QHFHSxTbkVE/yDjqCLJwenTb9ABecD8WL+OY53v7P2hwRlZGUZI4ZkuUiZbKAoQhbMy+SSA45vptK/cnVfsryqIgJO7YXK9wTfsQXKYLYCUuRQGgGVB5Ji9JedvAPspiPoUIa3hZQvsn6Ixu4RZAV+fGhFGGTKWYTC6gW+9gQFFhRhe3RgN0wvzLYYecjafHR0POBu2i3WZJaQMVHr70whZ1vmkrIDZpWCJ9uGW8mdQNGEAYGw0ZEWtokWMXV1c+JThyXNtBKtzZI3uqqpGfyVZweiG216K/RiS8KhxU5FqJaKH7bAIqXrXVv2jvwNVSCyiE8be8jwfNnZfwKURcBqlHMCafPgkVnGm+ROlAmbp/CT7USaPjFv8T2IfPTy9/l/d4JrIYFFiCUf9KsuNJyP60qbvtANKQ1m508iRX+e/Es/SRx9l1EHjJJ7ipbAalgaivfe3+wMCYQtV5uRa2MxoSTVVahs9YCdC2kuw396HugXrhQcuYHNIfV+G+7znm3rv6Sm6p12GPv46siCoD+KqCtS2oJzugXh8ePha6F8L/Wuhfy30r4X+tdC/Fvq/s9BTNd6p0NsCO/mu9LcG8GcZx8LaeZllKyiQCp74a4M1cZ+Eit4XMuMU2QWCqblmGGA8+qZWoBsMwhhtLlERyYr0fNXZfqcP2Q6Slrs1r4QWC69lk0pwsmpA/IBL2uxzMXDwqhow873ipUu1kf8VyYBpTv6PTfNBWF0aBA+lXl8+dgz05hvbyP8tA03VpukUBr0U89ts2QhMVsSlQY3yLfJ5IX8S9PhANehCcCPMORDoV+jUfEEXgd2WGatQItV0jQit/J0hMUQT2hfZbdLml8m6ew1YRbQ76TZ0uXglcl2rDrrSoBxEqXOFPZtMEvx2wAs5lgvDlRtLPXk+jkjlrfYd+lIpfkGMDT8PSHpo7XJL8Ahe3VincQ8PC/WFZzBse+V5Xoeuh9tOSj6/mVI9ZBTg1CUEVI4ZdZfPPCub0vvYk/PIwjYsL62jlqTA6CE/I//69v4x6Mge2R7iItRXtAky82YoeCz2R0yM0Y31xZ6xmvH7FaKKLHIA5X549I1WFwfraObf3m7aqn//5273bL4S1EWy4NZu1AuSap2pI+gpwRoL+pgkG4bNoibeyHV+uqTo/dDeC19v4mN7/KMJ4EutfbdLH2q/txvlprUa6j6/1FbWoGgiuu6hOiEeep52oe5oOgvDLUu36LetR6dfaPuE9lqdMDvXm/TIY58eGxXKotDG/dgERece/1/tUj+aWuKdVNQwsb0/fvt9n8YRzm6XIpE2ZTTCYUKOU64WwneGiNXmjKzOIk0L7adUOMril2x+YDWohVyoptke1fx8hgEzRjqnZQyHI+yZyIV0NLhjrBcutKE6QytU6IQ5EadKZ3qBJI4gURBAUYNZVixZhnk08z09pVX/9WSGqEJvT0IQxBrhQOSADWqMn3E85P3xMO+XmT+P9VcCzHdJYEugDumZc4UZm0Zb1CehrGjbdKQdjnBgx+PDHZsvl8sx9z+PtVlMal47+Xl6ef3u9vqAeKp2eGj9QNkn0XFJM8cmP1EiDv46Pjw+Gf9jfOT7ZG0dtOvoEz4T9ZvUpF++mpL7t37TqnOEQ8xOiowjKVe1wdZ1UfoY1XDyObuj/1nv+xTSf4pjE/16TdcL9yarKlqm+dPXR5iLG4+xULugLJ6T5h7iRYPsfai7jH324vezwYNsao6iguMrRBhqn6gk9b+vVTQd1MmUtAskl0GHA58fWhE7PRHV0cBBebxwX6Ttlv+beyoFs/ozXe7bn8jwJc2o+HsWfcI//+3RR4JvuWh9HWWI/ZIviD6IpQTF64LTFtsnX2zrh86VXt8m23U3nIX+dgbrPsv3FA8ofz805OGXFxmaSrWxPtm8qv4E8M5V+Q==
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"}>

Access token passed with Bearer prefix in Authorization header

<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: eJzdWN1u2zYUfhVCN2sBW3acZi2MoljatIXXLiiaFLtoAoSWjiU2MqmSlB3P8N2eZI+2J9k51L+sND/AdrGbRKbIc77z/1FbLwQTaJFaoaQ39c5jYRjIMFVCWobPmYGQWcU0cPwfAwu55Yxbq8U8s2BYCAshcY+QjLOUayuCLOG62BdpgCWgKA0rYVCH7w08lYLmpHAWokoDeiUCOC63nuDBz6gNN6I4vgQL2njTr9sO1C9SfM+AzU6YWjAumZp/g8DiKUFvU25jfJZ4Hn8RmErBjERr+J4JDQjA6gwGngliWHJvuvXsJqUjBi2UkbfbDbqKT7PlHDRp1RAoHRryj7kWKVsojS6IhHTW+eyYSYjweQUM32SSnMjnCbAVTxD6gieJYXMeXJOEq/GVX6JHw/Smhq8WCwO2hRrPmj7YGDaIQONeDAzPEutNxwNvKaRYZkt8dvYUYhOxFLarsm3rb/yGDjLZZ7MGm2nJMJpkNfiPBXgw7vHycRlRthY2pjCXKeTi1+em1oa7kVQRvqTdJlXSgKH3k/GY/gUKoUpLjzxNExG4qI6+GcK3bchLNWW0Fflpl2tVfdCKsLA0DcVVprYtPulUFunnWFYmhUAsCvWGYgA3PLDJhq1j7oo0UEmCEiGkENwMpbJDIYcEZM4NVB6oXfI1d1kbAbqhbYkI97018DDJlxy94uEzAlmmCb3++ejZ84PJZAIvgufB4Xx+GEyCF0fjgzusxLh6uzKA99V1uo89XyTfUI+qxA9cSQppLJcBsAun6MKjarzwMGUvPNLeEnRfEO+yJGGyoVTIUKxEmPFk3+b61x5EAmBAGoFtQthNA8BcqQS4vA1BEdS2prNaEmlqN2tShVkEkdKb+xv6Cduvkj1WvSlE9SsygUofEFOdd/yONSSDlWnrYtlVhJ2j1MC15htSXbfgvqKzwuZ21bu6iR9kWmPl4w64pXO1/JDvdj2waJRN0w4IobI8mXXawG3yzmlzo+O69sH4iouEhkdT9uSoFE5YHyOcQNMMojGP2VmOhErDISrIF++WfdqBXA6GljfGKDDm5hM1a5WZ3nxvi51hYVHaGiZc7Wj4yRDXKCTsqXCFkWs5hRv7eA0ST+9JJ7qwa6ZdkVhu6ccNvc7fihYlwmDbZiYLAjBmgT2F5lmMxeBIz5aEPsvHUVv2nBPlSjMCWJCknoMHD5pjzfkAWiv9RoXOdno+aU+KblW1C6g+3Zc1lS/Rsl2P+J6mUTeK1z2G73Y93v8ieWZjpcUfEO655uiBI/7/5ZoZ6tPY0hlxbyxSp6bjIzeWsBG6mYTk+zgVH4AeL4mrvQauQR+jg90KWc0jYul50ldcm/yBQGJFTD9yHNYx86k3Knj/iCpiWFXEaNvh6rtiQ82oBl4Ou+9ScAJLVViF+zKd4FpsbWqmo1GI74Y8Fb6INJfWF2q0mnj7zPPM0mSIbhNj8tc9ki5rl51R5uQBLx1XRY7nCwWHzX1ek9jjImnLydRhxZ9m7Bo2jFIb3VMkrM/O4/JSUfCLq5acK5arYcvMWDYHap4LcYOdx5Hrqxwju2JPkDuCE2A1zhvnhpQH8HTAwI/8jtgpKw6+3KhMk0eGCO4V3mMwe5opsvXm7te7cvb/+vv5vm2uB+LF4hrwUsGNKeHlkgrMdNFsgWCVB125uj7vDnhVKVLo6CaHHl+osu6RQrt6XKKdVE9Zmiptf6lCWodEvK+X2rlQb96rseoQe/L3n389JZrO2dkaQmHifArATRBziZyBy5BhplUcnxWlgRYrZJSgfTazdBM3+CZZDI3C3SAiyfAlJoHdDIrz7nIZYJ+iZRyDA9QZikjQzF/jbROsU2ZUIkKWKrzRQxBLlagIuxOGWKIAijnNvjVLYAWJG+fUL9ytfY45gdSShGAKKgwmbQ8UdiDhKLYLmDNPQ5QlxZ3FfRxw0w2PhQiHcC65lGibRwQjQN7qOmJZBZh0mIQTf7zn8/V67XP32lc6GhVnzejj7M3b07O3Qzqzq2leHQeqnVAFGfWVsrqojeTxmownz/xD/8ARSGUsomvg+Yhzuvvpo5vAjXHy33xHKbLbIk0ZpQleFQm7c9a26LJfy68rhLXVZ3Fhuv9VpNtqsaPF6AsStN0SSfyik92OlvOrt2vAwlA4w/4bSdMp/+6Hk15vXFPnrb+fuON09XBd/97AH/oV5AdQSoL9SCR3fBX5geLWvlr7Jf3QrnE8MJpPPhec6Cm79VNcL55yDMpNE0mJs5uUu8tdSUwcwHwXzYq06cc9+rZrMo/3b2nc8GIW1XP42s3h4oGk92LrjuQcAv2l4PUeeUnNBifjq2p7/ubWA9UQy3eTpy6RhP0DjJGAMw==
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: eJztW/1u28gRf5UF/4lTSPJH4uROKIo6cZJz6ktc27mgdw4uK3Il7ZkieVzSsmrovz5JH61P0t/MLr9pR05coCh6ONzJ5O7M7HzP7PDGC5TxU51kOo68sXc+10aoKEhiHWUCv3OjApHFItQmEzIMhfQzfaVEIDMp5CxVaqGizIjJSmRzJeJ0JiNtJIETOhJ+HBm8F5Nch4GOZmISxv7lSJxjbapMHmKrTOl3lqcRUC11NheJnOmIYYy8gRcnKuU/jgJQaFR6pX11UKA+BmFYlMhULlSmUuONf7lpneogEvHkN+VnFvzRIfBdaWNBDjxNa37PVbrCHxHA4M/GglT9nutUAf1UhkYNPOPP1UJ64xsvWyW03GQpTuet14M27nf5YqJSEU+B04/TwBA3zaVOxDRO6ycVByJSM8ncxZs8SpUM5CRU4kqGuRJAHYLP0r8kCJ93Po9uIT2eTo3KNiIbQlYzlWJtoKYS0vDGOwNvoSO9yBf4zedxYEO90FkbZfOsP8pr2iiivjNbEQsIk06tRl9L4C6o+kR7TULKZWj13s4O/Q/alkEl6KdMklD7zNnt3wxRd1ODnqSkVJm2u0mXS33iJzpTC1Mjw2oPqMh0FtKDw/qWDh+gb6VpkAlkUkeG7cMkytdTRxgxSAoDxYGQkzxNYqOwSmKPjMREFdbDFjgSUJAGWjbPCOqSGgm7jIK+bWSYf1jIaPUHmGOgr3SQg9XAksb5bA70DZCnLK7RRYQjXQ+jOBvqaEjsmUijSilVYvvFc2STBdpfhzVODFgiaRyGKv2Qho2/35FWYVcMMZEmhXI5zcMX0miDv2DK8zh4P/3AoK3PwQ+YzExlGVkFbdFT5a98/IY+NEWqg65x8vaFhHp4+K2u5SJhWT7bf/p8d29vT33nP/efTCZP/D3/u6ff73XE6q0HHnFbW3XaDPruaGe00wFF/s+BIi3IyO02dQOiW861TyKCESnsJLkSDkN0VIw86j1qEx08HmNh3XD7mlBIPF8E8+H0mOCw76+2iq2FXJHexXAQpHV6KqLYrtLRVRxeqeBxExsL/4voaNW34HO6NW675BN+DtsJAMwymQXQtC4zp3AHNLMYkkJsggV+nCvENDjmjGKZbEXBAXM4lJlCrLTIC5MswuhUAyatcu7M+vaBYPNtBE8ZLCh+YnsAtQgU7fbnMpopoTMKrQylgV+E6kqF1npvc1wnhb1tZt6RtdIc2vHgNvb8+c5ur41Ft2hHP+hDx0nmRelO+jWJeOaWPJwt/1S34wK+2NLWjU+hs/HSOn+1AEphYbOG5v1W1499nmWJGW9vuycjP15sJ6m+kv5qeMu5TxQARaQaZLoILDVtBymrpg9S4qShtJSADGAHcR4GsLCMnkk6jdVlp41kHSLTEBkO9FueahNoP7sXX1996FD+tg5oTVlHkAPK6gzqHKebg/5ByTCb+8gxu07RgYRcGCawkA6dKsohsATM03FwKFemNyHpxffk2X4bDXkVSn4sUMp/AJUMOCDIQDpT8SyVCSRzqug03868NyVESrJLkMBlcFAkX8exjTLfhOXMwhJhAQzwoVlpcCLTbEXHPptLBlphmcRxqGR0G5oshTPsliRpgJQRMK2NGwd1vXYSO8hA+yTPVF1QMk0lGUSZykFz30+5OGj7xh55yRJkkb81w7MhiwHZfhauYFSSkzGfwpOPiDS6r3+tU/Dwucx+j59tnhIl0f0d77su7U1PW4IfcK2DHDiTka/EBSO68KjMufCgQhfs9huANiXidY6AGtWQVllu98zVXx0S2ThUZDQyTZ2tNldZJ9SWaVSQygSmgQpapGZxutr8oPBGKGN6TvXSgepHZPw4uYdMyeV3DZ1giEJtWZZtRFwotu2qqcY1T3Snnd5tnVTu28KyBu0ua2sSgdwtQMLQnzPfEkGeHH7c/fHDx59XLy5P9o/fPE3P/3b6w/jJ+OXx+LudcVGXdsQCTOTyUZphCSpqVjtrZ7YQfQAi9sYv6WzslZR4PxWnagYG2XbJ+FlvunLGyJkS/udT2/QexANecDgoqsONU/1iw7q3nvwimJaF16DVy8uNud7VPoYiJgSmdCFl+j0s213bSMVnMvw1noR6ZvP5bVvBgF/4CceAt5RLkB7jQZJjpf9rJs2l3Qx1AUGqXEN0RdST+cVzSKgAbiEpCmzJhtNEwhV6icRu7iAhXaiX3l/PqR8ZCvEIpQ84E5Gf3ma/8auJ8xRhwP2VUwPkV9fWq45JG2x4d+s991dzPWtvoiV09lvIPbfFFHQwKnNkJQ5Pjg7gaZI4Ze2eqYg6kXCBcgqGUfMECzxHwVm+WMh0tVEhTeg+nIYCzgmximrJGjrqijqsBum3BStU5jd6Q8i6YYugZbJC8bgShQyVzZXI35Gn0bNIZnnKvLkeTi+HizhQIbmB8k3HQRRvuD+VQ45IxYlGm4PhYbNQ3io3GOEqc5QGmrq5rkz14ZBp3wIn05CAKMkyj++sVutEbtiPkqsw5hhmansts6zjsprZenhSbut5+oM089YbIkwFL1ZM6wJsh2Y9fOa235e5vWcmlaxOpKHeAveFoQomhiM9ODkqm/iGe95xnkFLhA7E1slfHg8QksBMq3dQKchoxW14iXwsSKHdF95A6JEa4UmlDpnz8lQKrlQmqJiohFyIxbYyIkQFdY1YZPh9KikhGrFfd6zemDM3o9Fo3WtCCKsIrw5gSZ5h2QzYGaOg8NlgDU7y9uz9OxR7KWJy0WWBUsKIwsCImx7BjwVQD8QtKtHz1upWz4sDitJwyz2vClXqefV2aVC/BiodiFLL3DJ7yI9WtFYlTtUUHgAJtltirekcPG48aC5bj8SZ40iDTVR6j8SRDXGlKTW94ERBYCTvFco+6BLxvl8ltkgn5gyd1S+jPhrfFzVJKpoNtebeNI0Xtq/ixIychNtoFg174qVMAzPq+LvN1Eut3s4nb3z9Xr99/fOr0/O/nr39Hoy52y0WxOBMc9v2s8CLpKDiWHUilz5Zl60gOYSQrvJQUdSrA65j1fZjm1fwwd7+/u735TH2dva6yeGBWKowHF5G8RL5HgOsfIUNjDY/KO4GR+In6E5g+5hmLM5fHNLtHt4u9GzOLSN1nUD8xd2eyROKbPizfhgH1fDNILjmnJsUfBcFIzeKeVvtdhtEpHxlDCLkqM2gk4dxNEcUWOFn4NAq1TeVzbRaaIFt9ziFZllXhmh9Y0vnh6wP15y2cVs5quC71EAXFZdh67zlpBynNj6t3J3s+U+Cp2p/+qxP33vP7aerJCubS6T9xbntJSVdOKnSA3MEqV5iZZ98WocpXOU3ZHMHTd2SDmLhlgiKu3tDMkV5ihUJCF7ImRrUrBdZV5u+MvRvTF+gg/GlWo3//uzHy2kfq18oX+YcORGhqWiEl0gfUeS0ANlAYBHtjit7HuuVJQzBtmXZBbtgWNtvwzxvY0PCKUAzXHwzRZMtEZesGNiuMUfLwqmVhSElHRXl3CEI4/iStDdPSo+2KhJdW4gI8KTuL8sUs4eoKI6GmxDmN+jCPloC91F1hcBWahchs05cR8VdVw8EymIdChkEyEsNktmh4yX0JJIJzpxZtk4Aja+0m57+gTjsXF9m85uZSpOUZjE67S0cpM5H6q9ZQRAiHE+CwkuE2TKAQsNIqY4O4V2M4eGKXtU+uEeFfFe37fTg9bl4ffTq+HAszlzss7fgqQptD2GuE5w1WyqXDtSrjRpjo8Cd3aKqVWhFHIbEfXgr42IP/gUOdSXBOFLGl64ut/fbWHUSgwPlbAXi1kXtKBcealMkworq60xdeB1GVUH5G5xUyP6V5z2cLnXDezMfJAfP3GgLzenPjGAhgft4Vg9QbvRl6/T1y+f7u/t88VQVLRsfAPnC0+HO7nB3/3x3Z/xkZ7yz83M3Ky/gFhbgKPPzFMGOWkU1Y9UmepSxyZd3Z06cJhY6e2QrDYKm0iEqq3hapHi3Zb7f2LY9ggpQJ81YO28H6iXCb6imcAChjC6LaNKTCvBuWm1pJaqrHOA+zVg7g3Rnk932EgWX9f1kuzKQRkh+KrW9lE3Rhi+QXXi1VlONgiqz/lQep4/vX1HmPnvWU+YeCLNaIMlL+RIrLJpoXOeW6VVhOLUMq8X7kfiouLStNPC33GSWX2HhZ2zaFXNKXvmdLWkbGY+JQ+UyOBHLFLFl/ZBryMhyqMx5eedz7AjUgIJ7bVLA3RIjv3g8sjdZbshlYw3uepTOdJCb1SOPEall36iPKWeGaKjBqmp9yOahqLHYithGnpWyySWPUzg+adupCFK5jAaU6WooLbcQWNKu71Cm++zXZR5oEKpDndn8348XCVQFpJODcDfzX260Nzpjd892fTw6Gdsg45xY02dw77wSQsHlIqhTHwS6m1aFLQCJimqRkBLFuWkoE9s52XyDNNtir4agvth1ZNJfWjsQx8U+JDnc+LRoGhhGor3MTmsW0ywLGdEFsHaVgljG6eU0jJeGVa49OWCsRdIYBOIyzHoBfQKdxorS6mo//+xMS+GVuEPlWWGTItkmMDZ+oMThzHaG77hj2uwKOLdZiIXWnM0hervjN/e99HVjBxBhcYHeaSDe70L2zjgR3H0me/95v9mKnusXZKzQEQuowNxGE957+OBWRAWo21C58ZhD5E2TWKbBLc35e2J1UMFSB1bkadhPgr1eg0ijg0Sf1e/PvnzVeV4va9wM6XuCdHLUmhUMYj9nc7EAJkWdhZWPqnFu1ATs4qg2oDZEMVZtO2ekH2d80fLNluPud/43TKbnMP+3lf+YrVAi1FA9vjAoZuTvmsg+qVZ1Lv1tyMOKumbUR8sbF/cuQNKQumsN1I+6SxTGmQyPWgMLt8E7p8W1kXg2JSGvpA7dHHMJe2+/AE60fg1wIpo+EuC6LxLFzH41n8YZAz38Mux3LZKLyf0GN3YAcC7NiUtbehPG24osPbX9q0fUvioTnzYK9gYWyzt1nX09hgi7O9Bp4mxdVzunWHa4rFmR9H/5slVy++jsvdh7vv9s5zF/LkOpTu5TujrNw5C86Jx7BsQkgv7UfrTQRDKRlFImOdfF9ouWno279/raoe5IkXvG6UuEAWIC/a7PV3zq3sQ2Lana3ac+JVNxsnUP+B5vUnmQFz0HX697xPAhcl2iv6ugw5r9e34I8r/FmqJlzxkerJXRtHhkY1ee8pAb4jnykr8o+vmJRrheKOT36QEYzE/o1HJGgd9rJubEj4W7gPJmyn6BRZu8bZddbpOdDCs74ehNVPV9oHWoFrEj2nNT0eW4c4B3Q5nokZ6hespGOt6+2vO6H1qdZRQBZreBMfZ1D6RPFUd4NsrKs+BLlQrZB+4DKMtSr/zo6sDpZBGBWq4DKRt1aUlzqUvuu0++zut3IxQRPzfgfBYWjVhQy2LC1eFUXxdXaZ8tjeKz2EIOZVvGqDC1bWsk0lePB0KNZqMW2LFwG/+4QnJDHBmCuD995jywrgE33oT/el3E/Lcfz7tnYxfnms1uGoHJs5AczdQtaxAhSg6yNbI/5w1eaWkkOvqkzqN7jMKs3c0Q9+rJXOyF4J9LkVYi0W+qR01dqBZ3TKjcJLb+9Y9/PrZXK2dLFWgzt65fXbtrmHYjtqyr7FSPSkfiKKNamZK8cDo0dG+jUAO7q5JsVXR3+Ss/vxwY5OZ9oGc0vyWWMkSNay8FY7ppTWLU3sqfR3EYzzR1+lUEALY3RW0e/gqEwza5A07zbYeEgUAF44X9foXrZ80juSwwd3U5y113nu/XBQevotMS0tVsFOFslITjsJGdEiusAEoHJdzjscMmz5fL5Ujy6xHSvm2312wfH7189e7s1ZD2rKt0rpID2U5R4BTWVX65wV3p0ZPRrv3ex2SgrkbP8d1frbZ1uRY4/iu/hHV2kSGR2U5CFIS1b0is+/3Fqwbp2g4Yfm4ODtGimxtKWpDhr9f02H7NyW4ZFEPIQX+DvM6fL3xT20vqJTnU5qe17P08/u7nPtj/s1/V3kF8+XHtVxJ+309k7yClSO4rSj7RH6m2nVsK6EWYItHaTeStk/quTn60rof2N6/I4UsXDapIeMmR0P2otQVktKrBbgdFSwL9tzYu3tzyRzJ3xKY/lcvtm1s3lGHEriYGURn5b2Nn5a8=
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: eJztPNty20aWv9LFF0spkrpYsh3W1NTQki90nEgrSnFNIlfcBJpkRyCA6QZEMyq9zZfsp+2X7Lk07qBMRpp5mN1UKgEB9OnT536D7jq+sp7RcaKjsDPoXM61FSr040iHiYDr1CpfJJEwSsL/50r4MpFCzoxSCwWv+GqqQ3hlsqKnkZnJUFuJ4IQOhReFFl+bpDrwdTgTkyDybvqdbieKlaHXRj7sa5W51Z4aZnAvYDt4KZZGLlSijO0Mfr2r4XoV6n+kSoxORTQVMhTR5HflJbBK49NYJnO4DmE9/EKsc+AjBG3UP1JtFGyemFR1O9abq4XsDO46ySrGJTYxgHDn/v4zvmxjPInF54f7+/g/OFoCwPBSxnGgPTrN3u8WkbsrwdOJWtDC2OChE81gKiiV9s2PkegkwBunlRe7NSoMwxI3ECepQ0u8sLHy9NThRTQSFk4UKBGnJo6sgrckrAHSTVTGKeJ2X4ihqGxLohDqW+CEDIDYftsyFILvFjJcfQes9/Wt9lMZIC4mSmdz2L4C8kJ5kfH71yEc6WsvjJKeDntIlIm0cOwpLFVlNv3acWijXPDVaYkSXWKIiYJAmSsTVH7/hEIAqyLg0gouArmcpsFrabWFXyBg88g/m14RaOklcEy4mIIsqwTQCfBXoKfKW3lwDeJQZaT2m1JDyxcS+NqBa/VVLmLi5Yvjo5cHh4eH6pX30ns+mTz3Dr1XR98fNtjaue92kNqapWkz6Af9/f5+A9QlyIIDhVKQoIpXZQNYt5xrD1lklKdgJfIV97CIR0HIUetRq9uxPqIAFuuqUJA93wRzdfER4ZC5KZaKnYVcodxFC52g1OmpCCN+S4e3UXCr/N3qbsT8b26Hbz1mPydbg7qROqf7oDs+AGMiEwOq2mXnMghwm1kEnAJ7Chr4aa7AfoLdTdBuyprh7RKFA5komwjePFPJzGRPNcAkk62mMg0ScSsDsHSC1LdiqKW/QFsNy30QC1/ham8uw5kSOkEz3mL4A3WrAtbedYbrPNO3zdQ7ZC1NQTqeXMdevtw/aNWxcI10tIM+dZQkWuTmpF2SkGbulafT5Z/LepzBFzuazfgUZDZasvFXC9hSMGyS0LRd69p3nydJbAd7e+5O34sWe7HRt9Jb9dac+1wBoBBFA1UXHEtJ2gGVVdUGKXFeEVqML7qgB1Ea+KBhCd6TeBqWZSeNqB0i0cAyONDvqdHW116yFV3fXDUw/1AGdI/xg58ClNUYxDkym4N+r2SQzD1pVNMoOpDAF4IJu6AMXSgMIeAVIJ6O/FO5sqXtIARTMzCea/Z7/uK4vg1aFSClAypigooK7CNk2HSmopmRMXDmQuFpHk+8dzlE2LgACXtZOKicqY8Re5lH7TJmWCLIgAF8kCzjn0uTrPDY47kkoMUukygKlAzXbcNhXyP8Nb6IESbruHVQ7+8dx4YJ4D5JE1VmlDRGokLkkR5I7tmUQta6bWzhl8xBZvFb1T1b1BhA20uCFSiVpGDMQ/fkgUfqb2tfyxg8fSxz3GJnq6eEgH17w/tTE/eqpc3Bd9HmgcjbRIaeEte00XUHHB5cgwhdk9mvANoUibcpONSwtGkR5TbPXPxqoEjKoUKrIdLUyWpzkXVMralGASkPYCpbgRSpWWRWmx8UrBFkMS2nOnGg2jeyXhRvwVPDOV7tNAhDZGJLvKxvBKrY1KuqGJcs0YN6+rB2ftQQW8FJK9Ae0rYqEhC7+RAwtMfMazzI89NPBz9effpl9frm/PjjuyNz+feL94Png5OPg1f7AxfINdkCO6HJh9SM8nFNYsd6xnnoEyBxODjBs5FVUuJsKi7UDAjESfzgRWu4MqbNCRP653Nd9Z7EAl6TO8iyw41D/WzBfWs++U0wNQ0vQSunlxtTvSl9BEVMEExuQvLwu5eXVvYgFJ/J4LdoEugZx/N7nMEAveASDAM8xVgC5RhuxCm86f2WSHvDi0FcACGVv4N4hekCfYbbBBPg2iZZgi1JcaqbUIaeb8KLG5ugLJRT7z9PqR8JCtIIUh+gTIh2eo/sxm82Sg24AfcrxQLIb67YVBwTF7B7d+933K/q+yS9sZYgs49B95KTKZDBMI+RlTg9Hw3B0sSRIemeqRDrY2AC5RQIhsUTeKHjMBini4U0q40Sadzu6iIQYJzAV2EuWdrOYjbDu1oIvxmsUIlXqQ1B1A26yFU+Ga5ExkPFsRLaO7Q0ehbKJDVEm6+96U1vEfkqQDOQP2kYiOwJ1adS4COE4ogjx2Bws5oo7+QLrHCZOaQGVIF0aaoHBhnXLeBkGjggcrTs7oPZahnJDetRchVE5MNsaS0Tiw0XS2bt5nm+rOXue2nntSeImPJfrwjXBZAdJOvpI7fjtsjtjIiUkzqWFmsLE+ndoCjYCAzp8HyUF4ytWGo4cJpgOVb7Yuf8h90uuCQgJssdiBTwCIQIGC4hHvMNSPd1pyt0X/XhTiEOibPymAquVCIwmSiYnLGFSxkheAX1FXyRpedGYkDUJ7vuSL0xZe76/f59qwqBWwX36gDm6FniTZeMMSQUHimshZN8GJ/9BMmeAZ+cVVlAKEGJAt+KuxbGDwRs3RVrRKLlKctWy4Mhemkwyy2PMlFqefRhaSF/9ZXpilzK3Gt8yE/MWhaJCzUFCwABtnuFtekSaFy5UX3tvi/GjiIVMmHq3RcjdnG5KlWt4EQBw5DfK0j7QJaQ9u0isYMyMSfoJH4J1tGoN1FFKSs2lIp7UxMtuK7i2AwxCZXReBuyxEtpfNtv2LvNxEutPswn7zx9pj+8/eXNxeV/jT98D4R52CxmyMCZ5lz2Y+BZUFBQrDiRC5/YZCvgHLiQpvBgUtQqA65iVbdjm2fw/uHx8cH3+TEO9w+bweFQLFUQ9G7CaAnxHgEsbAU7Ro4Psj5UX/wMsuNzHdMOxOXr076gjtVCz+ZUMlJfY2A/HBsNEfizGD0b/CwfxkG1uBZEITNuEqCEEKMEoLZE22K1WyBC5SlrwUP26wQ6fxpDM0LHCnYGDFoh+rbQmVoJzedyjxNo4nWhiGwbazLfI3n4SmEblZXDAr4LDXSWcVnSzjUnJT+18WnlweTQe+4fqePpizZ5bz23Z1ZxkheXUPqzc5MAUMNJ5RaYPEjxEN5s40/tMJmpfEQ0N6zKlnQQM7OEUFzvDYIpjFOYJYDwQs5Ut6S9EHXV8ctd/8b4+dof3KjV4I8XP95M20j9WnkyJc8JHhqTRrAS5hl6TgZICgIaUa+4kuVhqyxBEbgsSybYOcPSenbztIwUCU4BOIOJr4ZossbinBRdrhqTt8yMWp4YYtBRYE4VgiCKblB60zi3aKss0OVERABNyvYyDzFbkAqjsLcJYl4FL1iHr4D5KKpCQFYsF0FkHbuKCuQmiwn6WEiLdSCk70NcaiGY7TlagpyEMoYzJ0zWCUCzSOqqpX8iCjvTl3B8M1MmNtj3b5S34CBlOmJ9jRmBG8HxJGB4A242d6AgYShUo1OwLhZNVsNismgPt8iQH6q2XQzfXoq3ozcfTwdi7Hwfd8GNCriGMNcxnDVZKhcOlLONEmFD352dtyplaJkfBo57YK2s8z3wL+yhbiUQDoXxxOXl3N+Gt84joMAkULnfui4d5boDuSkEwgrz60RddxqEKpzyI4xUQPYVO9uZLDXdezUeRANP1KgzzcnPDGFBAPdpXHZQbNzEzsXbk5fHB8fUeCqSlo0PAPHCUW//oHdwfHmwP3i+P9jf/6UZlWdwMw1wmHmpAWeHpaKSsmobPktI5fPemWOnjYROnnGmgdCU6UFmFU2zEG9d5PvIsu0IRAAraZb1vO6ol+B+AzUFAxDI8CbzJi2hAK3GtxlXxLqIAbYpxt5qy2Wd9UV2riUKSuvb0XZpII6Q/JxLe86brAyfbXbdKZWaShgUkfXn/DhtdP8Tae6LFy1p7lDY1QKCPENNrCArolGem4dXmeKUIqwa7fvik6LUtpDA31ObML2CzM5w2BVRSF7YnR3JhYxdpFD+GhgRJorYYTvkCjIY9bkHbOWdzTFkc7ro3EuTAq5LDPHFbp87WW7IZWMJblqUxnQQgySLEapl26iPzWeGcKiBRbU8ZPNU2PBumW9Dy4rR5JLGKRydNFcqfCOXYRcjXQ1CSyUE4rSrO+ThPtl1mfoaENWBTjj+96JFDKICqKOBcJ35bxfaK5Wxh2e7Po3OB+xknBGr2gyqnRdMyKicOXWsg4DsmiKxBUCiwFrEKERRaivCRHqOOl9BjUvsxRDUN6uOhPoJ64H4mK2DIIcKn7xNZYe+qL9mSZeyaZaFDLEBrF2mIJaRuZkG0dKSyNUnByxrJI5BgF8GtV6APAGellnJstpOP55pyawSVag6zGwUJC4Cw8IrDBzGXBl+oMe0WQs45SiEoVVncxDf5vjNtk1fN3YALMwa6I0C4nYN2Qf9hP/wmbj/ud1sRUv7BQdPrRuoyHaubxNsPXywdqMM1Lqt3HjMKcRNk0gaf01xfstdHVQgqQMrUhO0o8DtNWBpOIz1uNw/+3ar87Kc1rgZ0jOEdD6qzQr6kZe6yV8EMMnyLHjzWTE6DDkBmTjMDbAMkQ37cuUM5WNMjZZHa47r7/xnqEzLYf5fV/5luoKBUB50PjB/fbEuNB6K76hapb3vChfKwbEnY25S1aJ2NzRueWR95SLqZzabzDbRskgrqXJtU06pwAUe7K5L50nJDnc5RsFCwHV4HQ4tjnLmKTnE4amHAU1kIA73oiBdYOxTYF5UjzFMgrUYOeC4/jZDRpraYXQqN7PD9KSZe75EvSX9MvoPIMsfyh+7koe7yzddJ+xf2PJqzQXyiLs8PrFuhnhNDe7BoO7cRV2QHVw78MAP6jSg3VLePARbG+BEpMXRhxJbJHUirktIVTKo+r7FoGYzPC5lVtvMhmw8v44ts/MfcuVzMpznS7lGFPkqicUTNOrKe+n6Vi0JfeX4T5bJj/yWFL5F5F1eIgMvDXjSu6oB/QIexvVgDSxoGyeXE1U0p7gj1aJSj6Ropg6wCbmoHde6w9bALvfwuH03jGNAifp5J5DekgwDMuQFaAwIo3Ksg4rRm8u34uLtiXj18tUxhP2j0ncr0o2su0Zpte6gvnoqToAGbMVGODBcIVb5d0YANx1Usyt/qnPx0HWDcO9dv6KN5zvj98Pewb+vOEYyltl5lLG5jCG4w4rFKCkZmNH4TLwCoyiuLk94RCWbtXbF0j+wGTHKi5esOk1tcKVTsKDd2plqoM6wCrKV/Tk6PjqQh+qFenn84vv9/f2Do2M52W82Fy/KZRuZfeKAZWnWUmwQuzoEJ8Z5JIDCkjlKRq2SsZeigW98BzOtAuaqAjhUrLOXv97IXuhyrQkRxnJEjgQHTMpX/HM7+d1Mer3nTQHiUijEMFQVSYrOFkUUpdoBl5y8KNZZpaGmbFX8x9u3zcuotvW0tsNV7Cwh3o6wHoy9Z/ykh+rBtbeKuh6W5CD22aUhxvoAUXGD8xeeFG+ZcSxmmDB4wrEV0rdDEOT9XRzaN1rdYsmC+T5NgwB995xq/xjvIOAj/vawCn8i0QPEKdW3+XvJloUHW320WI7plDGROQH5R6bgdXlO8nNzoqoapRWr275syJkMJ7tvAd8iI4VcvG45+P19CweuwsLqtJDm6P8waS6UyzqxdDaN0rBJoOMtP3j9zyJQNptApSwwz7RNjUacpKeGpvl/vesMY/2DwsvPOKv+WkmjzBAkkO7gqeUMKxydagUS6bFwkzadmSJy4FfMg86eK6PtYQzWy03J3l3tu+Z7zqBu2z+YPlWLyJ2i474Hyz/08uFZT8a6ryG5DJO+jvZuDzuIff1DHDnL6notYCw/boH0uSARh4PE4IxQRRGIb7iPuJnGnfwz7qHT4mwCuZaPn4+oP426jvMBLKA05lNMhaCp/1KB80XwNmKBzZoJeYKp/poNEX1hHMUXsQMqws3yxEjNDZ1Yemq3K1R/1q+BHQi38C8rUDCkSA+Q++sXitTLInHXmdCvt5nv+/Dpsnk2cgquze7mMAk9huRwxiSjgoTIKUjqSREBLSjCF2Rd554+e5tGmZ67mRiaUkD94VGov+UsLVii3xW3qrJQvNzQqXyR2Pmff/73Lg+VjJfK1xA0U54BsT4PoNRb0HlFmeeZlaEYNrVU3gqmPYsTKwr8thsSSVZZXxubTBjzuU8laGzB1zOcXAdnD3lUwuNQEc6YxZHPuXgURDONMw4qBADclcMGF33/igJFHQkqcHJviICACEYLzueoc6DpYyRimBvamqVuLoEmCwW5+6zHFOBQWhjC2bD8CIcNeT4+0wIQOhDCQ/rgokrz5XLZl/S4H5nZnltr9z6OTt78NH7TwzX3RWmr4APqTlbazbQr/2aVUo7+8/4Bf+lsE8CuhA/+sYZmsbX2iVXuPf6Nf2PCSXiiviZ7cQAJZuk7WLasv3aKjwGqthVuDOp/NQJs2BxOj8vu7jCKuzLB/T3ehpTckL0HqkmjuZ+JBhjwhGu/vXRQpsrOhfOau2LtH7ZoPU9mOEO0mmTmOHy+Qbva+MMX1CNwRgER5LfQusRJaX3Dwd+XfdO7N2igpLNeheW+IcvtLkoF/CpudSPOKOB/Sx92VZf8BcUTbOlf89f5ydoFudnjt5FSWPD9X07g9SM=
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: eJztXOlu20gSfpUG/8QeSLLs2DmMwez6nCiZSTy2s1lMHCAtsiX1mGJzu0nLiuF/+yT7aPskW1XdzUuUR55kd4GB8iOQyT6qquv4qrrAuyASJtQyzaRKgv3gciINE0mUKplkDH7nRkQsUyzUgmeCcRaqxAh4p0WodMR4EjEjxwnPci2YGv4mwqzHaBkt4FliWDYRzPCpf2vYTGYTenr2hkViJBMR9YJOoFKhOdIxiIASI/SNDMUR7TtIInkjo5zHR3b7c9r9IIku/N6wQMo1bJMJbYL9j3eBRIYmgkdCw8sEXsHff++6FQ4Pu+WqsGMn0OIfudQCNs90LjqBCSdiyoP9uyCbpzjXZFom4+C+0xBauQ4bHAf3n+xSwmSHKprjfJBZBlviT56msQyJza3fDE6/q2yUahRCJoVx00peK3RYOQLFmcxifFATStAk76B5ZuI21cIYYYoXG9z4k2AygbOB4xvmMo6AXzaMVXj9xDCTilCOHPGbqBQcjj4Zx4Id84wfjLUQU1gNj1+AMkxzk7Eh6sz7t4Nf3p/QbpnmqFkqYRsRTGLczwLibqSBlTtAgZfnJjBz201U1pVJF8cPuQGGRzw2onpgHwOJfBeLnbu1XnEzgecmAx0K4Fzq8pXR4uF2gpHSUw5nFcBvccunKYn42d7u8+2dnR3xInwePh0On4Y74cuX/e0Fab9zSj7lc2Q+5QYtaMjDazacM6PADg7OBoWNWWtQeQaWBNrDNs7ebHbgLIBnlH024RmaypxxjZK8CiLNR9lVAFLqiR48qZ29HQ+HB9PZXGTMZEr7MxXMS5CsViXxHFRBwiHha80TI+HsjnH9+qqgG4pWnPAbJOK8OKkh0C1HwCQeA8tTa9qcFVbZgT9ueCyjYhIzwG0coWzGIkGLR+tHm6rq0KD1aG67o+vuVEUihqc1nVs4BlDBulaivs4mMpwUSj8BpR8KkbCxvBHJAgme4BVI8UNbqSgYV6PiECpq/xBNQPNSski1V1Zfvj3cCZ9Gu2Jv9KzX6y0QeqTSuSfQGyISMyFjpl+oVvhaJmGcR6VSld4ftUokBn4aYBDsHFQrAwoEklZ6faXlWCbgLAsh0PnLqjf+PYmXLrdV5hWPPJsokiqSiaEMXVvdH+LmKs0GSWXXoVKx4MkyedoA0dgXnu2TtEpOaOdUgWHBcYK5wTYkuB47RRfWOhy8M0QI8OzgLTgYTqLYhtIkPrD9WQIWleIRqbxgZJMEaL3cyiphBdIqPlqJjaQAO61gABc+7NtwwpMxHvQIAm4XzrU74hj6B+R/pujlOcUT8Hp46s6jsMNDJjMj4lGP/Y0cAy1n9lmeWIq2UvCNqDBTcF2ldpmtgmCR5FP0+X4Genj749O9/UkzVlCjKnpoBs1Sr8mpogkgu3FM7IBTgwjvTaYFFFV0Tmal8l+Lws4GCZy6hGPvgLiukWMYeAPGMpJ8GFtzsubThbilQGCXh8f74E9iisA2ABccMIsi/kKaABFI6TMtRhCHk9BGOycIrjWfA7syE1PTBirqcnBBX1jbT2lJ9PV2CwhUcMqxWTlM22kwHDAFcbEYld2QlfV4geS3hDWtjN1iD1p4ffYxwSDjGQRd9kYLjgujIPkq8xM32fs0wuj1iEUbegIMWYdUbhbDuhBI7cL39K+i0g+BwId0mSKtDCs6jZAUPTQiej1PMzXWPIVQZF09SI+QCml5h4GqjQWIU/v4XlmH8HlUYJtUyxt0D6jnIDIOAsN5Zm5A33oMtNcqAy1BVg4Lq8jsV+IkcYbS9rMvmgnGVbKyxqV8HivufYQXkDUzq4I/EwWNh2fFtJanDlZW31yQqR/O6UCmgP1BPb894tzb+8aIE/zvoxHnRd0xPhZtmircRGPyJ7SyZO4Awdy3Bq4R4Qq3YEGedcMdl3/kIeorR81/ffHuLdielhCIjHWqoPkU9wy7azn4fQZbd9gSlWh5a3Wr5cUB6AQGzJZXXpVaXr2emVeU0HZYoWVumGXygz1aqxLn3v+7IdZ4LkHGtQf1Yfc9duEkUhNTJCm6jxqYD8RbwHjQvpEiHDgHr4bxzCxTiQ0fIjkj9YOXdkSDpEq2oKYyw01GWk1tMHLHjEnISMax3YbwyIxD1mJBUYvr/B31EvPXk+GPoXwnX5/+enJ++cvF65dtmLnilUYFMeg+iR1mFy8CURmnC458bCXvKSS5ukXlQUfYqgPIXosfW5nPk2hnb2/7ZcHGTn+n3xI7ZiKOu9eJAuRpFyx9hc1drAf3QNHDOguQ9hGzuHrQVI4nVBAAhAvHD2xTNDF5miqNJ1tlxseFophgnRuHVRI5BSM3gmRbznYTWCIA8Biu572mgM6+jaMZJKBh4GfAoZWqb0qbgS0X8r0CitFZl4ZofWND57ukD7fgI0MSM9XY3PrWRQupXR5pyDqXcPptc8RWvtvBQ4GQEaQOReGBKYKUL2Fk2/k0mPGu8isg4UFdt7hb0bslXAWJAWAT8gQhuz0SIHjKx6JTsV6RhU36itC/Mn2RjPYBIO1/efbz9ahN1Ici5DlFTojQABjRS+gnGDntgmQgYBE2CWMKyKGAQJ7HemUOhmDTNnLBLhhW5tswT9PIkCweAxdvZRKimyaZ1I+4EEXHQlebJTqn5lClBR0l5QR0Y6UoycnTwqPNnTazNB9CzltNjjw8TOGs5i1EJSrprkJYWKML5uEQcB9l0g1ixdqw6TAAakYhgID8cogxFvIpGTMeRa5c2nWyBD1JeAo8Z1asQ1jNoKgb9ZBvI2Hn+jKLb8ZCA8ZOisBSY6QqR838QeBGBitxmbqGMFsEUNAwVKrBMXgXgy5rwWNa1T4wq6u2XF6YOT4/OL1kp4OTnyCLvajlldrltGYiU+A1mwkHB3gOTl1bt1cvNFneiyIPBqIqKIATD8FbGRd76DoiFjccBIfK6KsRrsDZY2cKJIBZt49bVxVWrgK2hUAYVhiD17sKFgRVBuWvcFIx+VcsFXldWgzvdTyIDp6k0Tw0pz9YRUQA9+GiGqBcgrVxfnr0fG97bxOZKZOWlRkAvLDb7W93t/cut/v7T/v7/f6vi6jcr+stwFEW5hqCHRa5KsYqTfIkI5P32u2P0ygmsyc206jWRDzEW4Z8Vy/pudRx8WYnxPKUtfNmoJ5B+I3FCBxAzJProiC6CAVo9qyoCFE9osAAq0tcL6sz10oeVAdiVOJqJ9ulgZkirOa0vTgbUHYwkKtis6ugUnKrUFAi608FO21y/wNp7rNnLWnuATPzKYA8rGN4fwFmSXluAa+84VQQVkP2PfZBUGpbauBveFFF8oq9n7Gwy9UuCr+zwTHiymQTJVQMKysXG66YD2GbsKqulP6bN6cdDO5FBRyCjwLPPUd8gdVcKvtUyxhh44qvIv1OoyTkJ5sU55Dv3un31/eQ63vI9T3k+h5yfQ+5vodc30Ou7yHX95Dre8jH3kMW6P8BDLg0Bh2w79w15Hela7dZSshTMq1m+uTwKqk3T+ZOtRACWrin1azM7+kKweQ2twWd3N5cVlchjd7ZZDyPJKKb3lVylRwYGYmyNgIJUR5iIVlpSIhCFefTpFOF9CV8QGHCXNRGRKi2mfERaNFyhdoS+DyK+hHtTwQPOAik8gXE8kVEF6725J7ahw5h/hfvHluTsgJUYONjjZXVi6EP4qczF2IgCl255eE86MoHlVaEkwQygRjOhUMWY6rHwulK6KpCVC2Vbe5rE7BgAeZQaC5T3HZvvroYX+y+3GkNdmdvvLNw9ZkycS0soiwckFp8gxvT6l6yuVVLZWXQ7ma+sqQyiFpqKS0qDygKjBxONswx+GCyXrOAXrke5j3gDQx24lKWPxTlLaHFKS0m9ZUS9eYAmxC83nB3qHhHs2kvU+096gGk33N7sXrEE0U6DMRQPL1AfRU4GqyXDU4uT9n56RF78fzFXo8hril7NxwIcDfW9QKQuA1FCplXbr3YIOo0hFX92wsAOyvuF/zKH4L3D/1eENwr33XScuYbF68Outv/uyol6Zj386hjE54CFsTSEQi/dDCDi3fsBThF9v7yCI/bVvqRTFe1/oK3QoNGOvFQ63inwVNjqXdYjnqU/9nd293mO+KZeL737GW/39/e3ePD/uIt73m1foZ1qWgKBoj3AwXoLDp9Mtvb76I8KosPlJa0ZRlpk+SGIEb1hW3xAAIqXniQWsfoNKrlGcKASDDgeFYQQR0lEF6F/fNx+rua9oZPFxXI4mPAMNIgZCmvGAlRFImSr/2FKpW+l6FhbHX6y8xgZSaqpLbl2I+jlW3MBIsUFuaxCQDLLA6B10aVBVYHTzeDdevaunVt3bq2bl1bt66tW9fWrWvr1rV169q6dW3durZuXVu3rq1b19ata+vWtXXr2p+3dW2hI22x0eOBz4j4yowr6o1yAG4gVPstD/TouN6u7WmrLzvkmEmlOZmi/RhIy8TtRzXDVUsyQmulj0DeqAj4+7iy/UInXrOGUs4udQz0WYyJykKxgLP7luVb9LLUxcMWxt2tbV1C75OypLwgmr1H9gn+uUTjswR0gwhLaZuGjGxXQ65lNqePzByk8o3An+BJ7gD8gnnqAxAwPUGu+Ri/RhPUozbK47Zba2QESJhHcVE4DxYHpFJ2le7CMraPJ7C9Pi0jTSgSrqWCEdu9nZYBAJ9CqjoG74+6R92zwVF30O33d0huGW4A5BJ/18jcg7QCmkBPjDSjCNonLNBeziIels8seClnIE/LJ3jeyvENHvFYpq7gEKTKkDJyPLJgy311aKsEUFvWQ205F9jVRQcuKYmVUrPLYqqcDsG4XON5TrIsNftbWxG86/JU9iRg5iTrSbV1Y7lpVGhAcdz9Ztsyxr5uWelTqaD2IpHMy6tp2X5jH3Tav5J04FyEbY1ZCGdnA8Lp6EgwT7KCtx16RXaMoexzbZ3PzG5TNORiF4+89cWUz5ZG9pltQPSySQN26drAlvJQbEJa04MkpL7sPnMTv5+rXKNEukDcD58J6FYN8i4Y0l+nPpi//nC5yBtFHJduuHo0kWdXcjQjXqoRwQoJknMk0EYTyosvPLoA/Qe60fPyA1En3lG1NFpj0f3Blt9mr2rlem1ZD+nvDLGFl5aKSr0vslzFNTS5b2bZ3r+yqa/WBVdOaukM+1i2XAXNZRt9Tvjw/lOzRLpUWO7qoSjWF8WxyvQHSqdthcplFcjWml2x39I6V4u428tIwbK7m9bKTHs+XE90l6SCQe02aGnG9HAC4xKTar5QheELwHs5or6nxtyR8ujE1dSoyoF6ZUupfy1cYenK5I/lo7oPLQcvIIFiEtv49z//tWmLUhczEUlIWql6KW5dAauZwjIXQsBTqBtsC6OugdxQK1886hqseAkQmysyZfNOtdkyxKtfeAyS61C3yFhmWCXAZqbMwmSFNepURbb7ScVqLLFGAmFyGFtUn4gZJHc3kESBI0YURVCLD8GXZnNaBFy3mtoOmlCB+5GckkJ0dK7oO85dXYNuJhhhcNsxR3ROsdioUckAHkJUJwv00QOcNTjvnV5/Qeaz2azH6XVP6fGWm2u2fhocnby9OOninPvyYrg8B4w5kQpzdFU+KrkU1Wln72lvm+7kIKIDdRV67DcEH/xyYTMOVDDw//WbiC52ZIDKttIY8jfkkER65zDLR/+lxJqLDvAm2QGVBnIBgDBB0AMz7+7wRuu9ju/v8TGEJE1QFqGTJn20wNbjA4I60uCLqL3sUJXbhr8w32RL2lzqbFk498AHGltw5pHdrUvOpRyxkLWUMzDAp9mDY6v48OzdBYKEofuS45QylEDzGUoY/t8ProIrF68saL6zz++CGPxDzsc43q577/p56jDsmmCY+4ES9q+SeYXKJiKzzOD/yFrrlO/RZgAY/VAMt2+WTigwjB2Np/IJiP4P819X/w==
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: eJzdWm1v20YS/isLfokN6MV24vQiFL2z4+SqtE1cy7kcWhvIilxJW1O77C5pWTX87X7J/bT7JTczu1y+iLaV1MABFwQJRe7LzOzMM88MeRslwsZGZrnUKhpF5wtpmVBJpqXKGVwXViQs1yw2gueCcZYYPsvZTqEsvxbJLou1sgLGGhFrkzCuEmblXPG8MILp6W8ihtErmS90kcP00x/Gu2ymDa7Ec8743AixhAUGUS/SmTAcJRknIIsV5lrG4jXtPFaJvJZJwdPXbsMz2u8EpYGZGTd8KXJhbDT69bal1JEqBUE52PiEybAa7NSLJI76vRBmDT8ULAQ/W0OM+L2QRoBcuSlEL7LxQix5NLqN8nWG421upJpHd3e9x7dHzY9Kxe+VYHPUkwphxLW0ztbd+zcGVFvPeGof25uWWwieCFOt98++P7rj4/74K63ba6lVrQMqRXeXuJTNcBuLsw/29vA/8NEc9sVLnmWpjMnJhr9ZXOO2tltm0AVz6WbHdU+rCeMMCWLnMk/xRsMlo7aMR+0YETcZSAkihgc73LJEzKSCYJOK5RiF00KmCSjNpqmOr55ZZjMRy5kXfheDkkOoqXkq2EndVQbsfCEg+JaFzdkUY/bj+/HPH9/QbrnhGNlasZ1m/AV/6NWiYxeUuekrnfel6uP4KbciuEB1ar9GEvUOi535tb7ndgH3bQ4RHMHhNO0rk80T7kUADksOZxXBtbjhy4xM/PLwxTf7BwcH4i/xN/Hz6fR5fBC/erW3v2HtD3Q4li35GpXPuEUEm/L4ik3XzOqlYEen44BxlgVsUhgVO6c/7PbgLEBntH2+4Dn8I9aMG7TkRUT4dxGBlQZiAHcaZ+/Gw+HBdLYWObO5NuWZClZakFBSq3QNriDhkPCx4cpKODtCtOaq4BuaVlwA5MKWZ+GkpiC3nIGSeAysyFxwczYpEbgHP655KpMwiVnQNk3QNnOhEG9FMqDAasFNx9Hc9GdX/aVORAp3Gz63cQzggk2vRH9dLWS8CE6/AKefCqHYXF4LtSHCWQU/j4lSDu2UIiiuZ+EQam7/kEwg871ikWtv7b58f3oQP09eiMPZy8FgsCHoa52tSwHLQERhFhTMdIVuhY+litMiqZyqyrboVUJZuLSgIMQ5uFYOEggUzbkGTtBGzqUCxKzl3rteM+E9ZvEKdzttXoPl1UKTVVFMpBIIbU08xM11lo9Vbdep1qng6j57uizR2hfujchalSa0c6YhsOA4IdxgGzLcgL1FCOscDugMGQKQHdCCQ+AozXaAr6D5IPZXCiIqwyPSRVBklwzoUG5rl3AG6TQfrcRmUkCc1jiYTx/uabzgao4HPQPW04dz7c94DPgxJvxZIspzyieAenjqHlHY8TGTuRXpbMD+QcBAy9kRA0ZHEg0zwEZ0mCVAV+VddhgEFqpYIuaXMxDh3cXlnbukGVu4UcCpjqRZ+TWBKoYAqpumpA6AWgE/fch0kNCaz8m8cv4rEeJsrODUJRx7D8x1hRrDwGsIlpnk09SFkwufPuQtDQY7Pz4ZAZ6klIFdAg4aMMci/kqeABlIm1MjZpCHVeyynTcEN4YjyZK5WNouUtG0g0/6wsV+Rksi1rstIFHBKad26zTtpsFw4BSkxWZW9kO29uMNkd8D3Stt7Bd7MMKbs0+IBtlSQfDlMmgBuDALElbZH7nNP2YJZq8vWLTlJ1iHECBVm6WwLiRSt/Ad/am59EMk8CFfpkwr45pPIyVFhAYXis06y/Xc8AxSkYN6sB4xFfLyHgNXmwswpynze20dqo6SwG0yI68RHtDPwWQcDIbz7NqCvw0YeK9zBlqCohwW1okd1fKkqxOwRvOzJ62CbnChtva4jK9TzUuMKA3kwsy54E8kQevmaZjWcdfTyvqTCYX68ZoOZCksBu7TM87DwydmnIC/X8w4J01g/FK2aet0E4OpPKGtLXMLDOauM3HNiFf4BYN4DoZ7vv4oYvRXjp7/bvLhPcSekZCIrANV8HzKe5bddhz8iMHWPXaPS3Q8db7V8eAIfAITZsej0pU6Hr1b2e+pqu2x4GV+mFPykzta5xJnJf77IS54zsHGjRvNYXcDNvEWaZgpkZTdZy3OB+YNNB68b6aJB64B1TCf2ftcYqdMkdiRAfeDh25ES6RataCXMsdNZkYvXTLyx4xFyEymqduG+MiKQ9XiSFEHdD7iXmL9bjH9eyw/yHdvf3lzdv7z5N2rLs5cQ6VZEAbhk9RhbvGQiKo8HTQqcyuhp5AEdZvOg0DY6QOoXgeOba3nm+Tg8HD/VVDjYO9gryN3rESa9q+UBubpFqywwtUuDsFLoljSOkeQRshZsIZATijnC2oIAMOF4we1KZvYIsu0wZOtK1PmhdBMcODGYRUllxDkVpBtq9l+AlMCCI/lZj1oG+j0aYBmrMDDAGcA0CrXt1XMwJYb9V6gYnTWVSA6bGz5fJ/84QYwMiYzU0/Tr+8gWkjj60hL0XmPpk9bI3bq3U0eAkNGkjoVAYEpg1QPYWTX+bSUKaHyT1DCo6Zvcb9iCUu4CgoDxCbmCim7OxIQeMnnoleLXpHHbflC6t9avkQmIyBIoz9e/nQ16zL1sYh5QZkTMjQQRkQJ8wwzp1uQAgQiwhVhTIM4lBAIeRwqcwgEV7YRBPtkWJvv0jxNo0ByfAwg3tkkRpgmmzSPOJii56irqxI9qHlW6UhHJTkR3VRrKnKKLCDa2nszy4op1Lz14qikhxmc1bpDKKVVfxvB4oZcMA+HAHxURTeYFRvEtseAqFmNBALqyynmWKinZMp4kvh2ad/bEvxE8Qx0zp1Zp7CaRVO3+iFPY2EPfbnjN3NhgGOrkFgaitTtaFh5ELiRxU5crq8gzYYECh6GTjU+AXSxCFkbiOlc+8hu79ry/sbMydnR23P2dvzmR6hiJ4260via1i5kBrrmK+HpAC8A1I2DvWajyekemjyYiOqkAE48BrSyPvfAX9hDXHMwHDpj2Y3wDc4BO9VgAay6y7x1UVPlImJDJMKwwhxQ7yLaMFSVlP8ESKWEr9gqKn1pM703+SACPFmjfWjef7CLiATu06SeoMq3YmdvX39zuH+4i8pURcvWCgBfeNHf2+/vH57v742e74329n7ZZOXlumUEeMniwkCywyZXLVilVc9yCvnSu8vjtJrJ/JmrNOo9kZLi3cd8t2/p+dJx8/VOjO0pF+ftRL2C9JuKGQBAytVVaIhuUgGavQodIepHBA6wvcXNfX3mRsuD+kCMWlzdYvsyMNfE1by3h7MBZ4cAuQibXUS1lltNgopZXwZ1uuz+FWXuy5cdZe4Rs+slkDzsY5R4AWFJdW6gV2Xg1BhWy/YD9klQaVt54G/4oorslZY442iX710E3NnhmHGl2kULhWFV52LHN/MhbRNXNbXWP281f3qY3EMHHJKPBuReI7/Abi61fZqdHrrVQlR6V9NqKpUdGVvESIRnBRA2MKZ7G4pIjuu8cC8mm8tNOVZQWUEh6F5nd0zc/6I3mvVWjDBGm9dgZ3QAvD6pbX/Z1rfdO6lmV74FfizmJGVwKNDsrmP5Dn+sfPC4Q3Hfemta6KPyCekP6jo3TXP4hS97/79MU1YHCH9IR2mblo1ca7owMl/TZxJHmfxB4OUlvrQ/FhCW5ggMTHdQaz7H7ymiZrZGeyx9rRtl2rrvL3BWNPTfbAyr3D10YTH0UdL3PxP/4YaTtuurjROx1F4ZGFcYfF+wyPPMjobDBJ71eSYHEkibygdSD68Pos2vHiagAUFK9zLWPe5Y6bKy1AQdxp1zaa+qme9u9Lo/eDjyvuoa7Rt4ejomoogejUTd+al73xfKM8TSz411PjO3TXi9j+8E5E1ZzX92MrLPbAfg07FWfOfvkDXjsdgFXj0AFtxcdsT8xG/XujBokT4I991nYlp1z7iNpvTrbZlN3n0639SNoM/zXd8QJfHcSl5mTNgNIViwIEUpsQaaEIUIxKPDb0wiLKXKcPfFKZULGEauJ/G3cKS1r3r+Xt1q+kI1eCO0wiS2859//XvXVXeTlUgksD9qA4gbXwm2uSDzAQEaa4gHYegFXWHpBUc661ssHQVkMl+t5ete/RUU5BK6DdwI64dEzmWOdJunqchdX0JjsyfTQMhFvFA61XOJxYZQsIBLj0qsgCVdAxsBh0JYIuziU/CJfE2LgAtqrEpheKwBeCQndoUH5rsn88IXCNTiY5TUYFoC4qCcS6zaDdbRgLdCWQLCMgrA6cAJDwZ7GzZfrVYDTo8H2syHfq4d/jh+/eb95E0f59xVb1iqc8DYSXRcYOouo8tzPU+MB88H+9TcBnwC6WryuO/J/HdsrTfRrZOvJZP/8Zdx3vtzcZMPsxQoEOpGxrz12Ptr+b1c1GsWgUG1JgKjroTBAHULBHFY4fYWm8MfTXp3h7fd92CEzNLiOSfdNL1upp3yBdMue/Szu06lrhBg21/fER4icyWIfxphNj+ve0CezcFfKdIj3+E9IEJjXLX7Jf4wBBcukZdp6KvPrflN3YMyPfBJX8M+bjRmhSyvPdvgZ3d1anH6YYKZhfu0U6XcK0q5/gLVLB+pdW3xdvZ1MuC/KFHnlG8RVyAJfheGuyf3Tgj5qvRa0ABo1n8Bv7onYw==
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: eJzlWety2zYWfhUM/8Se0cV24qTVdDpr59LabROv7Wx2GnsmEAlJiCmSAUDLqkf/9kn20fZJ9jsH4EUSvet0+2vb6bQyQQDn8p3vXHgfJcrGRhdO51k0ii5n2gqVJUWuMyfwu7QqES4XsVHSKSHFOJXZjbB6mklXGiXy8WcVOzHJjXAzJeI8swpbjYpzk/BjmQmdJfpWJ6VM8ZMe5GYqMy3pVpGoic5wC1baJ4xLnSY6m+LGPL4ZiJcsgcXuBKfj7szW4lw8TpxB1IvyQhm+9ySBvlaZWx0rf/ZJLeVLv+2cd9WHY3chjZwrp4yNRh/vN4z3PtNfSiVOXol8wkqyLNilabWQbobfGfbjr7h9A0TpRUZ9KbVRkMqZUvUiG8/UXEaj+8gtC9pinYE5otWqd+9PnCmZKNOc+fd+kPv4uN/o8nWH9zZ0as6BXtHqmo6yBV1jaffB3h79D9o43Es/ZVGkOmYLDz9bOuO+dVthyP5O+901ilqC1EZz2qX0oG3+ddmOxFRlyui4BUeSRGqGRmyWhcunRhYzvDKTdkZ+sflciVuZwgoCwJ4qwMSIhXYzbGmdw4hIxHjpdxRG31IA3Kilh3DO++zSOjUfCHEeDMxHEGqBklme2BFWbrUlnAdockT43ZuwHVxlUPKuj+W+zvqJdHIsLYwwkalVbS9+BJyWaS7Jt7ZloFuYYxLM/wtLsPHwrN7W8fRH2GhjhURUyfGSHTJX1sl5EQEF647UyTaUehGCcC4Bigi/1R02sj+fHz57sX9wcKC+iV/ET8fjp/FBfHi4t7/l3ndsEyvmcinG8IC0xEVjGd/UXjk6O6nZyrIT89Ix4SRi5+yn3R7IBcYkf7iZdEQJSyEN8dhVlBg5cVdRT+iBGuBJ4w1+F+SHrWKpnLAuNw1BVW5hJsqzdCnUnba4n9aNzKx2AwqkykOPtsz9YDBYbZnhEleCIBGA4cBaPMu+6THJIaxjwqsk5J9evHsrQG1aptp6kgXyJ1qliRX3HY4fCVzdEw9AomPVY6tj4QiYmMjYdSxVUOpYOl3YH5nMeqJGWXjNK/nBu9ZD4lxNlFFZrMIrPnguYeO1B+uvrQbiIlhkzUyJRtyJkwm7tol/mJfJxZOAgsPI30s3IyyR7bshsUOYmPHpDD8s+jc2RBIW6qR0ssjn2tElE5PP+dXKzWNAeaLT1F8DrCqzkCaxDK4u6vwv8FLL09n4h1i/06dvfn19fvnXi9NvYZgtwLVYaVILQ/TJ6gh/OK2tW6zRyBYqhms9eyrNVLcNHiLCTgyQeh089mg9XycHh4f739ZqHOwd7HXkjoVK0/5Nli8y4Q9suGKBhDELDF4VQQPxN2An8akDtH55/GoguFya6+nMkd7qroD7oTZnE1sWRW7Is21lqrxAewGFitwkTsn0HEFuFdu22R02iEzFylpploNNA539MURzghxuwDMgtAb6tokZXGkDlVSYR10VAM2+bgLRc+MG5vuMhztwZMxmpneq8z1FK238uYggis4HNOU89Wht5f74IH6aPFOHk+ddeO/Uu7t4IL0ZAFQSj1XNwJxBmkW82eWfDWUqqny8Jh0oXsOWDCdWtESncC0qbCwzqrG9SyDwXE5VrxW9ysWb8tWp/9HyJToZoUAa/fb8l5tJl6mPVSxLzpzI0CgYiSXME8qc/kAOEEREPJPZFHaEOJwQmHk8K0sEgm9JmIJDMmzt92met3Eg+XoMFB/aC6Jptsm6i2tT0F24h7NlRWqhqvRFRyM5txlpnt8QesuiZrRlQLMoyjGKYS4aW3xJq2gk3LJDqCzP+o8RLF6TC/voFW6vqnodZqW+wPYECjUU4ljMyvmYciyKcZ0KmSSo5VHIIzC9LYGTTBbQ2XmzjnGaJVOvM/0fZOFAfc7XN1NlUGNndWJZU6RtRyMqR9BFUE9Cwhuk2TqBAmEEKvRhWCfK2mJMD+0j+3hoN+JsgfrV+dGbS/Hm5PXPr0biIuQ+y5IYlfJ9dqYL6OoWKpQDsgSpG097LcNmSdA9tFw+EbWLAng8BlvZkHvwL+5QtzLzPW9oAIXvK/HWWQ4LjFNV562rlipXkRhSIYwTpmC9q2jLUE1S/h9IKmV+dfpWVVjaTu/r9SARPFtj02kBP1M6CwXch4t2ggoN1s75m5cvDvcPd0mZpml5tAKoF5719/b7+4eX+3ujp3ujvb1ft6vy6twqAoJkcWmQ7BxySStYtc2eOA75Ct2VO20utHviOw06TZk+Oqt8UpV4D1W+LW3GeZ4qmT2kTmgdt7v6mKcpHOebiXqB9JuqiQvTlZBNOkoB3k1ve1lJ6qYGeLzFTWiRt6z8VnqK4et5iCDmOeDaLXZoA13OtVpAe+0bgB0BclVfdsUygBKpm25J0FTW17U6XXb/HW3u8+cdbe6RsMs5ijyaY1R8gbDkPrcur6rAaVVYG7YfiA+KW9sGgZ9L67y90opnfNkVZhc17+xIyrg62yUL1a81k4sdz0OoIXytauqRBrP82oytR8ldTo1SczxE8snB3EuqL3bBLvintzHp4UfrJnm5PkTcnsrYMqZieFKiaINB/SCM2JzOeuZnUutHjiV1UUXJYehHeB0b979qmNUexyhjcvMStiYQ0O9XreuvN3XenJ80uxt8ActqylLWoIJmq47jOzDZ4PC4Q/HVqsPo77OQlH5TSYdpnv2JTXOubF4aRCHR9CQvs20DHX7lIPT/y0BVC0U5gmp2vmbDRpTRFMhJuyXPzo8K/ZOin9c00D5W4C5zBATyE9JaTmnIHq2XNGSPeRgIREVu2R40WR9FwzDMHzYFztAzyDBQVD/8eb8xfV8N2zNUr0PXgP+VmudBRbxXmpSG8M4VdjQcJljry0IPNOrdzA10Prw9iEi1jekK9GI27j7G+uWOk64b+10QjLz3KyvWbpT+Qa/7E8FRCHGG5XYqOjvhGpuIgHocj14eVTSdLaWhT2vnfBL+GjGnhEOjWuQtfVcNQj55GcUnsYP48QW/M+hA2AyFjNUuWpIBGoj1Y0cibPxuiegji/Qh3PefuEht4+U+GvNfb6pEfPrhcls3zhihVQizZBbPnxRkplpnTQhRW5Bjlwsu3hDVcUmuo68yEXWhFQmEvp47LQouP875S+3SxiX6h+bROhaal7cCrt4kdv71j3/u+sb4YqESjcKZJyjqLjTRm2W0CGECjXNEiTJo3Bz1TKgkVDrpW+q6FeIhNLpuWdXmkvoIpGB+jLKSWq9ET7WjTkWmqXJ+pJPTnKzI0cuoeJblaT7V1KepDAf4yiJTCxSYtyjkACgiK2Y0OQYm3JIPAQRzaujxepyDjrTkwpQcFgZP0zL0VjwdFVwLYFsCcUjOOQ08DI0gwMIqs0yPVRQAdADhwWBvy+aLxWIgeXmQm+kw7LXDn09evn578bpPe1bNx6nGDxQ7SR6XVPVU0RXK5NBTDJ4O9vm7AFgL0rXkqT5tbnxb3cRwK738CT7Uhuhy6s4NixTVKdmOnXUfGP9j9fmW2a7Vn/tD8GOd9/FgtP3dtVXvI2FRRsHB9/c0zn9v0tWKHn8pleFUBZ9Kw4Hg04O29DvpbrPa/tqpPhDuigc/E3dqXNF6RpzOJOw7jRti/a3PyCvqWQJl/W4B17/5PiCXv/8/fHKuZaUc6N8mDi5ca22rRlq10/vZuwvicRlIvklwN5zgwg9Ss9NIm7nOy0D/JYk6t3xHUYyU8339ul95cEOdHfzbZJprlDr/Blg4sow=
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: eJzdWdtyG7cZfhXM3kTK8CRakm1NJq0OdsM4Y6uW3HRqecbgLkgiWi42AJY0o+Fdn6SP1ifp9wN75kqWkl506gt5uYvDf/z+7wfugkiYUMvUSpUEJ8H1QhomkihVMrEMz5kREbOKhVpwKxhnoUqMwDctQqUjtl6IhPGEySSSKxlJHudfDLMLIXU5fk8M5gMMo9cs1XLFww2LuFlMFdfRPuNzLhNjsUPELcdPLcQSEwdBL1Cp0JwknESQ0Qi9kqE4dxJN/L4Zj8/9Ru/d7piUcs2XwgptgpOPdy09PyTy10ywyQVTMxJfTX8RocUsSV9Tbhd4TjAfv0ie00KcCS2txa+Z1ALCWJ2JXmDChVjy4OQusJuUphirZTIPtttee+PTYi+2lnZBAmixksbrlm8PyfSm2r8xoNp6xmPztb3dcgvBI6Gr9f7ez011dtavzPc0xXottap1oFKw/URLmZS2MTR7PBrRf4gFi33pkadpLEPn1OEvhta4q+2WanK5lX522PBsJUzpNCttTC/aIdAyfTt2xZcUUkLEKki5YZGYyQRB70IVGTDNZBxBaTaNVXj7jWEmFaGc5cLvU3JwZjAgFuyiHioDdr0QWrBlhrCeUu58eDv564dXbjerOWWYStheM97LeOgVOQWj7kOZL/1E2b5M+jR+yo0oQ6Dy2sdAkt7lYu/ztX5AnuG9sciYAM5p2ldGux7uBTOllxy+CvAsvvBl6kx8fHT4/GA8HosX4fPw2XT6LByHL1+ODnas/c45x7Al35DyKTeEJFMe3rLphhm1FOz0clJijXH5oDJL2Yis2Lt8s9+DL6Az2d4uuCXk2DCuyZI3QaT5zN4EsNJADPCm4Xs/Hs7DdLYRlhmrdOFTwQoLYq8ILog3CAUJJ9FnzRMj4bsLWr+5KmJDuRUXfEVCvC89NYXccgYlyQ0sS31yc3Yl5wm3mRY9/FjxWEblJGagbRyRbeYiIXwT0cAlVgtuOlzzpT+77S9VJGK8bcTcjhsQgs2opHhdL2S4KIN+gaCfCsD4XK5EsiPC+wp+viZKMbRTilJxIG7hhFrYPyQTZL5XLBfajw5ffjAdh8+iQ3E0Ox4MBjuCnqt0UwhYJCIJs3DJ7J4orOizTMI4i6qgMoWvXVSJxODRlGXNQgJBovnQoAlKy7lMgJi1WrelElCD5K9ZvMLdTpvXYHm9UM6qJCaVdIK2Jh7S5iq1k6S261SpWPDkPnv6KtHaF+9OnLUqTdzOqUJiwZ1IN2zjDDdgrwnCOocDnVEhgOxAC47ESRTbU9qZD7m/BusAjYCLVFYqsu8M6FHu0SHhDdJpPrcSm0mBPK1xobx8+K/hgidzcvQMVKMPv/ZnPAR+TBz+LAnluasnQD3yeo4o7OyMSWtEPBuwvzlgcMuZE5YlXqJhCmykgFkCuqroMsNSYJFkS8L8YgYhvH/4tPWPbsYjwqjEqY6iWcW1A1VKAVI3jp06ALUMP/OUaRVYSoRazElbBf+tKPNskhBxhNt7MNctaYyBKyTLTPJp7NPJp08fdUvBYNdnFyfAk9hVYF+ASw2YZxF/cpGACqT0pRYz1OEk9NUuNwTXmhPJklYsTRepaNohL/rC5PyVliSs91ugUMHLsXl0mfbTMBycwmmxW5XzIY+O4x2R34LuFTbOF3sww5uzLxwNMoWCiOUiaQFcVAUdVpmfuLEf0oiq1xMWbcUJFPKAVG0WY10UUr/w1v3rlUz4IQ54bw06Zd+6QivDbytodwnAQp661MpNpdHFSMr1nK8a3yRs8tAiCujpnlZrqgsQ19cEFPXMk3vE5ME+mqZNatVc8xTFrVUgxmh5skgSuxncJDfJqZERsEarpZPiJjBZiIg1St8EECTOlgmRCL1LH8iYmEvRSAyVaMST2KLXiqKFWi0nv2sG/CORBxoEq/wGs/wmoquEp9jd5m/9y5xhWrkUhpL1v88yj487WGZJKqjraKjy6L2iB/nTZV5iUIVu8uXhD+J7LmhFuEjQCVDTy9HFmLpbAJFwyU1NqJughtrtfVOFckeI1KI5rjQToJeu+UNmfHH4ctxZ7C7fFGCRN6gO7tcE32VGBNtGWDxakDtwrW3nrvW9ZHsrXzd+9o3Bu131v8JO8oDf7VRDqrR+z8KoTtFYgPJPY57cEsx1hLw/7oBnw4yKD0pVMwMG1XrU9wANDLINboxdEzSTLiTAe3x12k2pP2jRIh2wiaPXe4RiUOzHq3dv9+mBM2gPdnKK9nvjXrNznigXwxDG1dMrildBo5G9bPLq+jV7//qcvXj+4mjAiNcQLBKrLUmAY0glCfDxDv4WihSdV+ZRbBL1Wsaq/y4MACgsTFPDld9F7x963jEcbUPyd/l87+qH0/7BPslVwdujRRqPxof90UH/4Oj6YHTybHQyGv1jNxOKdUkGF2MFzlOMLXgKLghcJ+NXADO5esdeABTZh+tzcjcIGpYhMXmGjNGkxNlm0monHjq36e0e89SXegfv6ifhz+HR4QEfi2Px/Oj45Wg0Ojg84tPRqCNuc4bmyByofbREAoJv65J05ieQeedSMgEKlqJQetHu60jbIrcMMWsu7A8PUFBB7rUL65hAo3484zggCQwez0ohSCLQw0j4n0+L38dFb/hsN4A8PwaHkYYoC+Oou9SIeEZRNkqecPWQwqmELd3HVrI15a86g0crURe1q8d+mqxsby1YpJJvLLtN1JqOWXIG3hi1rtoMT0/3A88ZmzzRvWq3/A0uWoRZ7tBZFsdUlP0hKhEZWuHQn2c2F5pygvYU1KA8eu6YePCkg9A6WUPDofQ5ApusTc8Xte0/tTVt069qduVI9KZi7qQsvQfNth3Ldzi/cvhZh+I5Y2+fuldwsmOaoyeeEf9/mWaC/TQdBtHtBmDFbdOyke9oMy3txl1pnKbyjaDHT3TWfya4FvoUBnZvSGs+p7uPMsILLtkLIMhC0V1KqoyzB114nATD/GplWB3FDH1aDIlO9MuDquFd65Ry65uBVfdty4VYqlwxjMs0IfPC2tScDIcRvvV5KgcSfVJiB1INV+Ng9+LkCtrkhKtrGeM/d6z0qbKaZzbO54XtqvMA/6LXfWdymset79V3WsvLiTvQoOiGOfKY9UeG7oCkoEafG+t8Zn6b8oaAjhXkF4CPOyb57GVkn9ke8Ey4BejaIHZmSHko9nvM3ao1lz1h+cTvNirTZJE+hPv+syOd9Si5C6bu1+sCxn/8+XpXNweDKHO3YCX5Kb4Tz6+Uy0x8uSEEKy3oMtYVNzehqsTkOrqmgsVnqkh9lAGXkkvoSSmVpanS9s+lSyuXyL9Ur5qxUA3eSbNyEtv79z//tU9VnrOrtYgk+J+jzKCt7kTPNen+FMq7k+XJAY3VivptR8cy485I4lnfKIwWKEEMHxEEdtOrn2KFVFPxGj1Jz9HwubR0LEtdonWbGUXHgKmKfFupYjUHQMHFCRYgn3OWiDWalJWIKaAIohyO8Sliwm7cIghBtfStSagAQpITq3IOc+ppMc/8uZkhn3HmCpw/inByLnmSQDc6moKyiXGgWGQBgg5BOB6Mdmy+Xq8H3H0eKD0f5nPN8KfJ+au3V6/6NGdbndJUfqDciVSYEY4U2UUw4v1F7HnwbHDgWAmwCtLV5PFXwO1j7JbPayXlf/R6O88HK77YYRpjHGnrzHuXI/PH4tI7qN8PuAvbQuUGPuPFSfseCTi4ILTHYnd3dCL0QcfbLb32980OtqWhIIi6e+e6Jb9yj92p0i0BbvM626EjEUiC6RXXLleeKMre+5wJ7LN7r/U75SmQP9nUJSnkbNtvS2cwOar9bgHv6be67PTANX1lNZRJP5pgOrW1bzvkaVuv+5fvrgjqeV4Hqhp462pg/kBqdhqpXQ69DPSXJOqc8h0lOqrS9+Vw/+XeCWUB8aPJNJ/Agf4DTN8Jgw==
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/RWCTzYgS46bvhhBUN9aqA2KwnbQAo4BU7ujXcYUuSG5lhVBb/2Sflq/pGfI1dVy3ovWD9bucmY4c+ZyZi5LCoXXTdTOylN5W+sgyJaN0zYKPLeBShGdKMlQJKGMEYWzgXDqqXC+DGLsvFBWaFvqJ122yogRGWcrbSvWxJHzlbJa8R0wNNYWNrUVsaaVsVGrTckaI+OKx75IjhSuNSWsJS966SJ6VpPGEBumZ/KFDiRKXemIa72u6hjEwTX/sgQ0oVO5GMkewpGyCyPsjSPWKopQ85F1kZU9RZWcZdVaPSF+8UmySYpRjQx9kqJUUQlVeaIJjHWOT9QMV4Q1bFa0NuiKbW1fm6PSNkRlC2JUChXg4LQmTwkhxM5h6xjSK1thnBrvCgqhL3vSNeQTuMMSKYT4ky7oMt18Zsx1Dg9yjfJqgo8+yNO7udSc8JpUSR6HFkd4/+PoIvt3fn40XGUUhnvS05dWe8Id0bfUk6GoaaLk6VzGWcO6IXp4Jhe9naJa2xHDS7m4Z1Oh4WsCa58cH/PPts7ZK4W2UWUZ21KEtmAkxq0xM7iZI2LLC3jydp/xkeL6a9ooVpDsUXzDivABxRP5UTWN0UUCevA5sKH5BgZrdO4kee/8hSsJVtPz5cb1CL/Dy40+UxE5MZ5TGHXGY629hhbdSFXysmsAeYrIFnvMv0jHhoo83xP4gv92U/bRqjbWzuuvVL6A5vuM6X8UmiHu8xb1x43GrcnX7GAEpUBF63WcpVY7a/QvxI/3i95cnpPy5M8AcPrCUauKe1J2vSdyzzIecKR23Na52lMXs54cdH0+WHfEIDeK7MnsWm7zbe8vaeI6zyHXesMzIMYmnA4GJc6OVKP7uvIKs0y7wdOJZI+3bdzAXR5Br5gJ+XiPpfs1LDdcHTmpS3BW2VH5Q2//hDrrCjNVm9zNztlvQ/FImL6QApJdUfJYJvGkTEvCjdMcfdiy8yDyNWLShjT6Gw+eesZ0mepYQzi5JB7EAaghz+XolTYJhkYVdNgT1K/6O2ZPRaf4buZaz4gcwbn3D30ekptlMJej9Paj8xOFlpI//377MrY050Bsj2RRpSEs3cuWOp+ZQ7acECsEU0syhvkyuWo3Tp3kqtV27Ja9rYrU22hizekNbdM4H39YpXSdEv3T+tN2LayFX/TRSkkc/P3nX4e8bChxM6VShzqzKj0XtbIVJfpFpelxl07R1T6TIEqffF8MIxNlwIkZHwUHaQJRChyiCOKs1+kzaYsCs4g/g6F7uHO5PkzB/BTTZcEZXYrGYfWhorbOuAoTCCm2MMA5V8LSVBh6IsMFxTMoDSo1Qk3EWTKCEnRIJosXDlNGJ4ZPCUvheapak+IJnDMlEoNBrdRpucAWYS1iA6gYroTJwOlYdgGKDkV40j9+gfl0Ou2rdNzHpjLodMPgw/Di6tebqyPWQTYAi9lKnuDeKV3R8iKz7C4eIzlfJ8cnb/vf9d+wbuNChHcb/ly+uh/ulvEGcfy/bv4b181uZkR6joPGwGOuiFSC846c7pZLaJrhyzylFXLJazUqiAXn8xEc+OjNYsGfv7TkE0+i8pRP7ZpZc0kDidF04AOw4hhR0zfq6+C6Wz0OxfYS+koUj8xD39qBE4VAJLFiluap3MSNsxfL0GKTxy+vPlzdXkFcdYN/TXqPifS6Bw50eWRnG+Z3+S97wf/Zp70q77izQUPvV+L55FWFFWNkaQbnHlvNP9PT+Uk=
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: eJzdWNtu20YQ/ZUFX2oDukuWbcEwaitpqsZ1gthBiwYGvCKH1NbULrO7lKwKeuuX9NP6JZ1ZkiJ1cRwH6EP7YlPLndkztzOzXHoBJBp8biHwBiGPDdRwyfhaJFYo6Q2824kwDGSQKCEtw+fUQMCsYrEwlvE4Zr6SBvAd6lE6YLjfKr1g8IgPQkYsVJpxyYQMxEwEKY/xkRaUjrgUhtNBLIBQSFSMr+wE1jrHqYgDUjKOlf/QYLf4ToNJ6DWBSXgkJKFveDVPJaCdthEa4xnQM+HDFaJ4xS2/iDTAFHV+cDB/zFCiVMI1n4IFbbzBp+WW9dfpdAyaqTC3zpDl5kEkzqr8dNzaYBdMQoTPM0DDWCo18ICPY2AzHqfA0LexYWPuP5CG+9Y9ARZ0xOcUHA6JKPCnCkMDFn9r+JwKXYmL8Scw5d5g6dlFQlsxIBCB9ihkIU9j6w1aNW8qpJimU3xerWrLQm0spsJuH7lp68/8kQSZ3GezBptqydDDZDU0vhVgO0PlYEzQRe5tjvHX+jAL++VlfbTOFgxm9Syr031HGasxTbzVtlGlHjZ65a3uSFWWPoakO60W/cN0s3guPfIkiYXvgtr83ZCOZeW0RFOSWZFJ51m6mVG4XqL95AmCX011Z09QzUi3EqsI/1oxBWP5NPEQaW6aGv8OvnUvbUwLw33H1raw4bk73tl2DtUF4wWM7QImf+1Af1bnu2pVZyq2jX0prkwLOehZySsVsTIVSm8+K3hbbCUGGt28Yyf9VpshcmCkhcp9yq2HyevBI26jQGRO9vo9OG0fnbahE/b5SavVavc6fr9/tBt33NvqQv+k6/dPg+C4Q3v941542t2TEri5De2Tbrtz7J+0+0e0OTw9DnrdPFsG3seEAAZrtsyoBqv17CKO1fzckRTRaZLqRCFjng1TjO0Ui/hKLXhsF2zIMeIjY1IufTgn4zdo+YwI9wNYLmI2VNOEywU7eAPoC7k4PN9I2AEWU6dbb53UO0e3ndbgqD/onf7mPFbyZCUQO2n9vty1ncx+qjUaiDvgCXqpxnKY7XZElbOZVwlbmzJDWWQWC1PzFfpuaXOFFgXJMT5DpxDDV3V3jgrlhPVblBNoahTUZTEABW+vT+hSKbjF53Vfb0Eu2HvDGy1UOOHmvYaZUGkV8lipGLjcUUucSiODYSKk9NLwHbqDJbmGnSNce8hOuYZH++0nSJTe0U4NYbWiNNtMLLe0xU1vUTDrOmQnbei12i9qAFVqB62VHqrAwaHnV5XT9vD3Zk6X0vsCuTav16IA7ajfQ2hrEe+S0yCVpOSsfLghd+w65KPkqZ0oLf6AYMc1Ry/sjf8v14zwPC2xNGmOxLpxx2z5CIUMIDcJu3Cz40Ui3gI93tGMcwlcg75AB7sVsppHNGQWDZxlHZz8gUAmijg/crNfwknIa+YzbLOcnZtZk27mlF/Pf07WU0AGd98s+wqmKrcG96U6phHM2sQMms0A39V5Ihoi0lzahlDNWccjKzZ13Fgi6egpNSZ7vUfTXemqG8qYLNCFw9YR49lCbf+AeJEna9EkNrFdvB+xB1gwSml0TZ6o2Z0h64zKkQm739Bzz7Jj2BR7IxsD8VgoHpF+58JOcLODxO7ZgVQ0DaACq5H6nRsS7sNhjUEjamypHbBc8GyhUk0eqSO4c5z7MWuqqbH0xu7XD9mEMfB++uV21zbfB0OD+APgEM6NKeBlmnLM1L43QLC1B12ZOsp1At66BCl0rkkLGaqi3rnv6h0LW1B4TZokStvv1yEtQyLelEubuVBu3qmttRA7+PvPvw7pIsfZzRwCYSY0c3G8PPoTLrF9cxkwzDQR5uFkeUmgxQorAnSDjSzdSQ2+icO6UbgbRIT3zYCSwC5quby7jPnIT7SMHamGZwYiEtR+53g7A+sOMyoWAUsU3nHBn0iFkxayEoZYogKKObWhOYthBrHrrMQT7uY5xpzAiYqUYAoqDCZt93FqigVNV1nAnHkaojR29hh3GWZhGseUuQHCIZw4X0m0jSY9NBZLncJRVAEmHSZhp9Ha8fl8Pm9w97qBY1wzlzXNq9Hw9fXN6zrJrMqJq4wD1U6g/JRmz6K6iEayeOFg12t0G22SxTnSIroKHrphP/ERYDuPK93kv/RhIS8Vi+NHM4k5ctMq9/wyp+pPxecGR10FHndxdRRf8zYJmxpJ7iJkxgn6lHQslzT3fdTxakXL2TXdETlag2nxxDeaqlf/3Q8Wex3xQAxefrdw4riQdY+vBv7Srw9fgFLMzCWSO/qhHQVk3bloLS9z7sGHfMQ5ZJvfFb4I5wufNTZ8le0mpk+q6HeGrlV1XnjzmpoFzztJ2UUfXBfNH8jK4pVcVHRvN9QMAv0lQHtFzogqsK+dr7dnb54UWLegbDd55g5Hp38AekQYfw==
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: eJzdWdtyI7cR/RXUvESqIocS92arXE6k1dpWvJE3e0lStVaVwBmQhDUcjAGMJFrFt3xJPi1fktONuZOSpa3KQ7IP2uEAaPT19AHmLkqVS6wuvDZ5dBR9XGonVJ4WRude4Ll0KhXeiEw7L2SWicTkTmHMqsTYFJNvMaLzhZgbK6RIpZdCLqxSK5rFL3Nh7ELm2knaRaRqrnNI1bnwS9UInJU6S0nQLDPJVSw+YswqV9AwaVLIhc6lV2kcjSJTKMvSzlJo7ZS91ol6C03O8lRf67SU2XGtxOuwwXtWmOZgfSGtXCmvrIuOPt8NnPAp17+WSpydCjNn7We/qIRWaRotpF/iOcd6/CJ7m52gzCiy6tdSWwW9vC3VKHLJUq1kdHQX+XVBS5y3MDPabEbDjc/L1UxZ2rX2LjzvrnTBfqwcgKmxOBa5WuD5WsG3osytkqmcZUpcywyqzxEpJ2YyuSIJlweXca09DLPrVn0znzvle1pjrdulNhJCLZTFXARQlpmPjg5G0UrnelWu8Mz2VGIzvdJ+uGXf1r/IW1oo8l02W+VLmwsEmaxW8ZcqeBi0YjWWcBGPVjr+Y1wlxsnJuM2ap4VwaFQrB9kTbS5IVMhgR6unBwf0HzLeY196lEWR6YSDOvnFkYy7zm6FpTz3OqxOunnMb7RXK9dRq0lUr31GL3qpvxWC40Exo5YL6Atlm4E96fr1ikLsF+ofnHCFSvS8MmOf4ieFwwSk42m3PLimrRKrElgyU5j16fzsr5/e8G7eSoIc4MPeAEOsutYOkkfQoHbvPoy5HefGj3U+pvkz6VSTGm38Pkea7G6Eva9k/SAdFbHzAJQIYep7Gmu2Yj2KUIMriahFeFa3clWwi1++eP7qcDqdqq+SV8mz2exZMk2+/vrgcMvbP3FwnFjJNRlfSEfQyjU6WwtnVkocvztrwNeJG+2XpvSEQICivXc/7o8QC9hMvvdL6Qk+10Ja8uTPUWrl3P8cwUuxivGmF/swH8HDcrFWXjhvbIvBtQexV4oQZOsA6zxsZe40YndK8vtSkRuGJS7lNSnxvonUDHrrOYykMIiyYGMw44NeAMJKq0b4AazSabNIOFibpeSbhcoJ3gnqqcQGELsjNLfj+dV4ZVKV4W0v57bCQG2lN4Py9Wapk2WT9Esk/UypXCyAr/mWCrXCj1ClnrpTi8ZwYF8dhE7aP6QTdL5XLU7tR6evPJxNk2fpc/Vi/jKO4y1FX5tiXStYFyIpswwNmp4orWhY50lWpm1SuTrWnFUqd3h0MBB1jtTy0ECRaiE1aIGxmjpc1jqB46+74Px7Hm8ReKfPOwB9szTsVVKTOA5BWx8PaXNTgFJ0dp0ZkymZ3+fP0C8G++LdEXurtYR3LgwKC+FEuWEbdlwsviMI2zkd6IxeAWQHWkgUTm7EHpo/uQ+1f5OjogoKkSkbQ/bZgQHlHp0SwSE73ceSxFwr1GmHHFbtI4wmS5kvKNBz0Ksx4jqeywT4ccb4syKUl9xPgHoU9QpRxMmJ0N6pbB6LvzEwsDh3BHYTNJoUwEZKmBWgq80uN2kUVjkxkc9RvYIQPjxcbMIjr3hEGjU4taNptnnNoEolQOaCG5M5TMBcXTKDBkuF0Mk57dvkv1JNnZ3liLpG2Edw1xVZjInXKJa5Zo5HUkL5jNG3DBz28eT0CHiSBYLNDbixQAQ+8UfOBHQgY99ZNUcfzhPVJQ/SWkk07V5S0fdD1fRVqP2CRRLWhy3QqBDlzD26TYdlmA5OwVZsd+VqyqPzeEvlcxC/2seVsAcrvL/6lGmQqw1ELtdFSxQcNjJWubfS+U9FSt3rCUIHeUJ0nwGp3SyDXDTSIHjD/0b90G3oWFMfER5ihe/aWUMfJyWCmHvMUPcw615zCLOZo1dEvhuBQ9LQeOD2IKXuk/eRJndOBJyKQl4jkyjxu7KnL2rhpOuXCCel6YxEGIaiqY8szQ7PsEF4+fuyzwcq1weXnjcOIBDF/67C6EdkB3WrhECQuJQn7gy23UH54RZcV2GXc3Xrv3yHHKu3pFNv66VdlVj8asga+pcElM8DerPXeP7sw09i+urFy4N9vmUgDCkTYJObl1lGiBRObuQw2ul5OET1N5xJKsSiJK2rk/2OhYdPOn114QnYZuxrNAdyCD2fdra/GHpkWFXt6l2p1DgYlm12iN8BeC3InewwvAKH4aWGLHGesPo37ot917x44sH0/8s1Z9jPEu+keyRULm8z8FFonqXVfs03RseF/lHR4wVdMJwonMLsMRzMb8hquaCrpaYSqiM4RqDI0tCt1UKFmyhaFE2qO6xJS/omoXomVDjjpnAmd4Pz0GYC6kFMh5XfdZ91qlamsg3zSksEZ+l94Y4mkxRjY1noWC9w0POxNpPrabR9NfXBU9NY3CfGheEdki5ax32g/Alhr93Xso/wYrT7rua4St26aQ0oGY7NRJ8oweGSKm3DASXch1VN/7In51KEbZr7CCIx+hb4w6TsMugoLsUemrtiAXRJkbEbCpkonMdVvIgHYo9EtfCbtSkteWQM5b69ZCreTZS7aMa/vqvZy5///nHbNkZCULornPqqOwNWL0iqdCYS0lNCNB7kouUWwAuipiApdHQJCY/PTV39YOpclaDpFF5XFoWx/k9NSNuQ6O/bV/1caCdvVVqzSOz9+5//2ideA6Z6o1KNYyQ3CHUbzg9McgPnDeEUVYHAYoP6UJZPFKVjRpbNx85gtgLpFRhEEvj1qMuZE6AVvUaHpKuHFCdNogM3qB3leTNn6NBRGHBrlSxzk5kFMAohziGAYk5t8UZkCgc27vSEGnwPPUNO+DULQQoaBJOmJwY4pCVYdggYm2fVogws3VHMpOAeh2Up1CE9VzLPYRsRYRibO8bFugqQdEjCaXyw5fObm5tY8nBs7GJSrXWTt2ev35x/eDOmNZuWAbZxoNpJTVISltTVRTAS4jU9mD6Pn8WHzC2N89Cuo8/be74JDJO401j+Zz4wVEXiQYQmRYYDK7mAfX5XQfbn+rND1L2i4Nvj+ra1B9x4cbT9tYCwGxC5hHNJ5N0d0aJPNtts6HW4OmdEh3HIj/b6+14P/3c/Iuz0yxVBefstgZfTAYzbyKMVf+oXgQdUqcl8q8kF/bCMBU/05977iuzsi3s/DO1Upe5s+bqrSa3iMBU2dEVRofYXK9j//vCgix74/NGLX5hNbajoenSLH2661Ob7N9TJZNXm2hZ/xS2+eiArd/po2O2DCvSXFNq55BvCMTTdb5vpYeTeBU1/DLPJMxdgef8BlZQh0Q==
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: eJzdWW1vG7kR/ivEfqkNaCXbSe56xuFav+Su6qWum8RtgZwBU7uUxPNquUdybauGvvWX9Kf1l/SZ4b5Ka58ToEDRfHBWS85wXp+Z4T5GqXKJ1YXXJo+Oo49L7YTK08Lo3As8l06lwhuRaeeFzDKRmNwprFmVGJs6MTdWyFzoPNV3Oi1lJmYqM/lC5wuiw5KxC5lrSSeIVM11Do46F36pGmazUmcpUcwyk9yOo1FkCmWZZJpCLKfsnU7UOwgxbQ46C8TvWRBaAlkhrVwpr6yLjj89bil3Ua5mygozb4SHgO5WF6xEISEzHzkWJyJXCzzfKUgvytwqmcpZpsSdzEol5jCEEzOZ3BKHm4MbkljTEb+Uyq7xI4cU+Gnmc6dILqt+KbVV0AW0To0ilyzVSkbHj5FfF7QV9lYLZbEXNpJl5qPjg1G00rlelSs8bzajx5ptplfabx/Z1/VP8oEIRT6ks1W+tLmAiUlrNf5SAQ+DVCzGEibi1UrGv8eVf05P49Zn8Gb3LG/LoaOctwiGaLOtVMtHTM+jzTWxcgUd44j66OCA/kNQeZxLj7IoMp2wUyc/O+Lx2DmtsBRlXgfqpBtO/EZ7tXIdsczsZ5WQ3b32Gb3oReCOC062ckWohwLyQthmYU+6fkog4/q58BsnXKESPa/U2OekEg4bEI7n0suThVVqBW5j8XGprBKrEqk6U9h1dTH9y9VbPs1bSRmNFNxLQSRkTQXh7rQD51Enh/ehzEOcGx/rPKb9M+lUExqt/z5FmvRumL2veP1BuiXeOy+9iuCmvqVBs+PrUYQcXEl4LcKzepCrgk381ZvXXx8eHR2p3yZfJ69ms1fJUfLNNweHO9b+MzvHiZVck/KFdIRcnKOztXBmpcTJ5bTBNifutV+a0hNCTc/F3uWP+yP4Ajozci2lJ4RaC2nJkj9FqZVz/1MEK43VGG96vg/74TyQi7XywnljW5irLYizUrggWyMUCE9p2crcafjunPj3uSI2DHNcyjsS4n3jqRnk1nMoSW4QZcHKYMcHvQCElVaN8ANYpdOGSDhom6Vkm4XKCVxVOuYU68bQdNA1D/H8Nl6ZVGV424u5HTcgBPtRSfF6v9TJsgn6JYJ+plQuFsDXfEeEWuAXiFJvHZSiURzYVzuhE/bPyQSZnxSLQ/vF4SsPZ0fJq/S1ejP/ajwe7wh6Zop1LWCdiCTMkpOZnyisaFnnSVambVC52tccVSp3eHRQEHmO0PKQQJFoITSIwFhNFS5rjcD+111w/jWLtwg8aPMOQN8vDVuVxKQWgqCtj4d0uClQ0DunzozJlMyfsmeoF1vn4t0xW6vTg9DJhUFiwZ1INxzDhhuL7wnCBrcDnVErgOxAC4nEyY3YQ/En8yH373NkVEEuMmWjyD4bMKDci0MiGGTQfMxJzLVCnnZ6r6p8hNVkKfMFOXqOLieGX+O5TIAfU8afFaG85HoC1COvV4giTk+F9k5l87H4KwMDs3PH6G6CRJMC2EgBswJ0tdHlJo3AKqdO5FNUUxDCh4frTXhkiheEUYNTA0WzjWsGVUoBUhetJ6nDDZirU2arwFIidGJO+zb4b1WTZ9McXtdw+wjmuiWNsfEOyTLX3OMRl5A+MeqWgcE+np4fA0+y0MNyAW40EKGf+B1HAiqQsZdWzVGH80R1mwdpraQ27cmmom+HquirkPsFsySsD0egUMHLmXtxmQ5k2I6egrXYrcrVlhfH8Y7IF2j8ahtXzJ7N8D71ObdBrlYQsVwnLbXg0JGxyr2Tzl8VKVWvz2C6FSfU7jMgtYdl4ItCGhhv+N+o77oNTRf1iPBcV3jZ7tq2cVLCibnHDvVEZ90rDmE39+hVI9/1wCFJaDxweyuknuL3kTZ3JgIORSHvEEkU+F3eR29q5iTrlzAnoWlGIgxD0tQjS3PCKxwQXv4674stkevBpWeNAzBE8l9WGP2C6KBqlRAIUi/lqXdGt91B+e0jOK/CKRfqwX/5CTmod7hTbeuFXRVY/Gq7a+jP4DScEzaUCTDHzcssI6QJExkZgji8DsNRn9FMUoIVJUlTDc4DhIefNVV1YQeYZewZQJ8UpefzzvHX25puZ0tLPRQijeGg2WaA/QCQteB1OqB4lfR9C13lssScYPU/uN71TfPmMwfO/y/TTHGepX6SbmeQkXzMlo1CUSyt9mu+kDkp9I+KHq/p4uBUYbqyJzAwvyGt5YJubpoIr0bra6pzvTk4TmyZZk1DEe1uKLSOjY3BJrSBVas4sNMlKpdWm2E+6MISLqvR1Vl8Fl9Oz+JpfMATKNKYuENWVu6WNHtW0FHE/QsdRPoPE+wI3lKxAk9TNoq86JxasXbzloLkEPh/aegKbqHC/Rr5KppUF3KTtoeeBDCaVKU2tvWlSIiOofu4c7UyVfBgX2nJkUvvC3c8maRYi2Whx3qBCdmPtZncHbEyfR4fvOSrxifYuLA8wOm6jcwPlKAhr+r4bNu28GI0fMl1UmFDXe23etnLKfedhCAwSWX3MNmFi8SqW7rp8bkR4ZjmIoe6P/0AgOdu9ibIKG7EHroixQzodidjMxQyUfsjocaL8RbbY1ERfrs2pSWLxBDuuxueYbqZ+BjN+Nf3ddv3x7993NWNSw164VuMy9VlC4sXOFUyU/fWE0I0FmRU5NrJBFGDeOS6aMOD6dzU8IoRh2EP8w2515VFYaz/fePS1iX6h/ZVPxbazTtQ1hCJvX//81/71BCixb9Xqcb8zRcH6iEMXjwdhGEhuFNUqQCNDTJBWR7FSsetbDaPncFuhWlBYBFB4Nej7rCRoBzQa7QWdGeTYkSnPuoe847yfJgzNK0VBkOJSpa5ycwCRQAuzsGAfE79xL3IFCZdbpEIlvn6fIaY8GtmghA0cCZtTwyAXkuMJ8FhrJ5VizKMN458JgU3ESBLIQ7JuZJ5Dt1ogoCyuePCU2cBgg5BeDQ+2LH5/f39WPLy2NjFpKJ1k3fTs7cXH97GRLNpW+fWD5Q7qUlKuqaos4tgJPjr6ODo9fjV+JCbcuM8pOvI8+65bxX6yRuMTiH/3/kOUiWFR6mZFBkme1KZbfxYgfGn+utI1L3L4Wv2CoG3IBnIt4TNiPLxkRr0K5ttNvQ6fEpgoNaO3N5+DnjSUv/djyqD6ody1nxb6ZW6lwv+uV9InhGlHm5aSa7ph+UUD81OXTo+z7h776uOcV/0v308K84zn14G2gJC8qIr/U4P2+sDfnhLxUBWlaKtkrdcJasH0rJeytcd3tsFM4hAf0mgQZJvCQpQt75rtoeVJwmaEhN2k2Wu0Yn+BzAkFSQ=
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: eJzdWN1u47gVfhVCN50BHNvJZlJssFhsZpJZuDvNBk0WvZgJYFo6triRSC1JxXEN3/VJ9tH6JP0OJVmyrTSbAQoUvUkkmufw8Dvf+dM6SsjFVhVeGR2dR5ly3gmlE/WoklJm/Cx8SsKtnKdc3KXKCdJJYZT2As+lo0R4I1hQyCzrkzV2IbVyks8QCc2Vhkz9W2y0I6ialSpLlF6IWWbih2E0iExBNohMEhjmyD6qmD7hmEl7ArYV0sqcPFkXnX9e713nusxnZIWZC0uxsYljU92DKsTcWFHIhdLhiKG4EJoWeH5kc0WpLclEzjISjzIrScxxNSdmMn5gDdPxlC1UfMRvJdkVXjSswKuZzx15vFv6rVSWYDtkHQ0iF6eUy+h8HflVwVuBIC3IYi8wkWXmo/PxIMqVVnmZ43mzGawbtZnKld8/cveuf5VPLCh0350t+dJqAUj51jT8WgOPYdU9y7qCHed498l4zP/gSQ9P8qMsikzFAdnRr46tW3e0F5Zd61Ul3eFLeAXLwgMA/3keXFpbY2a/UswYeOUzXmh5cIDFbQpxs8xWIjcJwXNSi3a7WKYqTkUuV8BlTpZ0DIKbnEBK5yW/gZ0QoSfwSkOgZv8bSwsQsKJlvTgQ81LHvIB9k0u8mlIncrsgyMdvwa8dA7bnwEueQyqYyfGkjWd/zUjkOEk+kBZL5VMhwUkFxwsQtrSyG2dDMalCsWDJTrCapYa/sZZQrBJcqj6s4gWTAaTC2XAXRx42yh71ACIZISYgLYXDRgRF5yrWLEUMrKAlBBc9Ess3cS0XlijHk2POPR3hfkdKHwEgOZOOtuTbI0XSoSEAx6mQRszmEgSL8ExPMi8CDc5O350eyxM6oz+/O/t2PB4fn76Lk7OzA1LcAZkaRLgFyO+SAhcZRhvWXDl98gobkAXtD/XrMDb5wdl/2/KMUQYIKTzTZcpoj0UVReGsTD0QeHwzmewadxcM+6MGIvTUYZhcNfwGHqxHuAJMmSuynBArlUPxkZ3fEPZLpepLxGnyS7RH9i/RUHwArKBvKAwIo0ziDMEpC74NAIOKGjG8urEG0JN9DdB9zpaz45MeZwO72JRZwsbApI8/DVBkfEj8GpxdkkhMCLdUIunLbRiAGI2FoqhNdIixy/fvQ8oI23NjSdQZtGb3JuTrl5MVQLfS7STgz1WaH2zdVKRGU3S/HxZVMTjEaq/oYVeVWKgTxgF5mfeDvavgA4qfZ0iY1uzDB1rFmZEPnAqE4/uz7qlKpkI6/Ge100DPYP+LB1zxNiDKItVVXxS5Cdt4f+nSa+PB0qrA3BnkyJflL4nbB0QfZ9RecJKw47mw6teGTW9+vn3boxBYaK7inyNgZg0SGuA3LrrHScy052i/fw43Sy4or6TAzT7zUZWhuFYmrZWrgNW2wekcdUDNm3bXPuHi0iJreeygZ/qCHd5Uu0OHUbch3eA9ZguNR/JqavwL+u54c6efCb2BkI8gD7dmXd0n7xrlbOvXKGejucPjtIXi3jRc2xO+wQHV4su6r/dMbtquHTTGUJhKd2PBJVN2TZ4Zk5HUB2o5h4D0MDNUchSUPwEOJKlKw8ERobRWp1yjcHz9CRrSB9q9LWnDSW+PWGHpUG0zE/CgAIhdGcfk3LzMMm5lU7TboYVfs/Rp1VHuKplJridFyZbULX+P4PGrWtFuCiZrjf2APowvyc+XnePv92+5HymtdB89tqDhZpse9T2JoK1573suvtn0wPyLlqVPjVX/oOQAmnev7NL/v6CZ6KaTxxyJaAzH7GEEIUfIeCj8Ye64KNRPxI/3XNjfk7RkLwBwWOFbywXPnN05BKswIjU8sS7CGFhIFohG9fw6UjvDa2VN3+R6SbmpjcW+0qKqRqn3hTsfjRL8diQLNVQLK7UfKjN6PInYyL0pyHNmXzynxlU/92i6b5G4ZUJUfmzw2DpEVgv1VFpB2U7CFzUXm8qya9vFzYTbCsGM5WYrrudwbtKrkbuuctMdPVNRHSPy0nnu7JD85uoJCSVMSdPKRjEVb9DZVW0Kui2VBRgKGdPbgaAhmtpdteeiFvxuZUrLiBzBuO+noV/ten4dzcLbx6Y7/cvf7w7vFlJb3WsU0rnGvEpTbTM3VjtGiC2CIQpDng4C0TbC2HURE1XpuWnCWcYhnOveK3JlURjrf9i6tHWJ+rFd2uVCu/kgdLZC4s2//vn7W55JpLhdUqJcKniOw5gcp1IvKLSHYNq2NxM167d9dBhV0VU6/JLNj5zBblILve24B7V8+PQSI/3wMmJlgDMTtVBcs5eY7clXvajJ0A8VJhGe4lSbzCyQdOBiDQXsc65dS5FhKM1COeY0ED4szcAJNPisBBQ0cCZvx+iGnBgGneCwcD0M/WUW7hO+aEkRihbEEpjDduZSY9Dm+Rb5lLSjtldH0Eg4U5wMxweYL5fLoQw/D41djGpZN/o0+XB1fXt1xDKbtk1r/cCxk5i45MGjiS5OI5W/TsYnp8NvhsehATTOw7qOPZ96vtPtE7hTJf6XPgjWMeDRjIyKTCLpbGpI13Wa/dx8Jgw5qb0f8lkKJHjDes0t3i8222x4ufqUFtIv7IEz289hz0Ly3/2o2HvLB8677bfFIM6jccj5f9jw134h/A+mNO1xa8k9v9gQuFXJbAoCg1sJcV4sulIHHcimW0B/vOLUKuu829ach1Bz6ofOB0KpVx3d++WnMoH/dsb0XZHvOLBQBb7fbq9+eVZgm7Cr3QzQPfqIfwMD/h6N
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: eJzdWetu2zgWfhVCfyYZ2I7t3DrBYLBp0os7RRvEyQ6wTYDSEm1zIosakrLrCfxvn2QfbZ9kv0PqZsvJOOgCC+yfVpHIcz/fufgxiIQJtUytVElwFtxMpWEiiVIlE8vwnBkRMauYFjxiMbfCWDYX2uA4U2MWcctZqmIZLlkkxjLBaZkwOxVM6QlPpOFEuXgXqsQIEB5lMo5kMmGjWIUPnaAVqFRod3QQQQwj9FyG4soRvgZrnEi55jNhwTs4+/K4IfdtIv/IBBtcklAcoo1+F6HFLUlfU26neE5wn/5yVAdEU4s/MqkFWFqdiVZgwqmY8eDsMbDLlM4aqyFmsFq1NjmeF0zYQtopcdZiLo3XIOcLkfSyYrx2oGI95rF5lvc9nTYp2c7Q9363S//BmBbGpEeeptDJ2e/gd0PyPdbopZqsa6W/7dWv8SltZaWN6YU3O15saFw4eqIQAYnxzudJxC7xcD7RQszIubmvETHxrHBHPRbslLvQ0mIstI8ubthd4MiRUlrFsdB3Adt7d3l1ve9YqEUiNFHzt5KQoqfkaSiEvrUTZdsyaROhETeiNG1l6y/eF60g03EAu66bRkZN87eCsdIzDjMHeBbf+Cx1Rjo5Pjrt9ft98So8DQ9Ho8OwH56ednsNswWrIgB2JX0pxjyLbT25GlQ/gSKZgyydHwGfPDN3Z9XrdDvdBvG/Vwle0Wd70rIQzhzDPWrhvhgxA0vmae+TBGTXnblPrU3N2cFB/qYTqtlBquWch8v2E3pfCRBKKMxurz8yBNJiKsMphEFAQZRlHZxIQh/LTu6Ri8moxcxUZXHEEC30jpM2PgzDKU8mMCvpZCVcBoV+z7Q0kQzti+z65rYh+Yc6oRUhRJSBynKI5FN6d9LvkVd2GnItGiwGOUn4xdEEF4qha0E4gSMwnlTRJV+aGjsAvZgI/RS/w5PjTTaU7jBlTpSljiqlfUSUwXQi1ETzFJ65FqTN9xvvXUkRjCuS4GWgKJ+Ij8rD33dxGXpaLC6IgT4iS0dXXNslqT2ccke04jJSKhY8eYqNryuNIqsjlhJNn+Mmp7pCnSmrxHMIfV2caWL0jxMBpJThj2U9YjMViRgpkNoMxssTV0seSyrueRkxHqoRO65u/GCYgUgxckYtOsz1BdLdTZjJfOFDxvT2WaiXqS29Y+Qk4cTHoXYf4J1F0oJS5y65S86NjAQbazVzUtwFJgtDYYwitA9VnM2SFuOV5HmmjnzngLtUL6hlENHuiC+p3HqtPnnw9/Z0Zdg/kmvpEKzyJ8zyp4iGCU/B3eZv/cv33EydF2aIQTj4v19BTk62VJDC22gyXMRXquzMK6pX6CaoksFVZuIlucSRhz9GmSVkZ1aE0wTdRUzwiebC1N0C9IRL7mpC3TnOSTYj22/yrVC9/uFahEpHwf2q5prvMuOro5/6DS1vqBz8WhSGvHlzzcgC/UeVEcFqLSx2FuSx0+mstnKt85KbrChjRPQbmkiV2c9N9f8CYPKAbxQCagddsoNnYVSnaCzGqHsxTx4IsreEPEoqkhyeDTM0/NRnrWdAp6I340tCA4NsgxsRPgiJsXQhIZOO025LSn2nRYt0ABOHnnuEYlDsw/Dzp3164IzKbIedoyteutfsgifKxTCEcUVrSPEq6DSylw3e3Lxl128v2KvTV8cdxgbWwSKXCHZEuAuYsRRxZIrw8fHOxLdQpBY28Cg2oO5izVj1vwsDAAoL09RwZWer8N6oHx5GR+J4fPLcc8NwxIbk3+bzveH783bPtXAVvO0sUr/bP2p3e+3e8U2ve3bYPet2/9HMhIIuyeBirMB5irEpZhhUrqhDxq8AZjD8zF4BFNntzQW5W5SNGc+QMZqUeL2keJ/LKOOxT51mNvivhKCtzflqndRneFe/CH+Ojo96vC9OxOnxyU/dbrd3dMxH3WZXfZ1PLsJNPAnj0QwJiAFb+yydIhhDQKylZnTqBqS8ylOwFIXSi/atPX5ou7q+3g1sirxhiPE6YQKjRKGgouvVLqzzCb840PLjFgks0SGUQpBEKcqr8H++LH53i97wsBlAoCB0Gz2MNNSyMHRQcsyBrK6jSPMqBpmpnLSQwqmELd3HjWRbl39YNC27K1EXFSj1nbKyvYVgkUp+sOwhwWwl88Fr45SrU65cYKKm+WWfWsZVa6NPdK+2tOz5HIfOXUsxB5Hcn+MsjqkmTzEdufXKIxE48luGdTojTsieojMo1zFbLvZetJ6o92pCa6UvENdkbHq+rLG/31R0s/uqbm8bb0rnQbPVFvJbfF/5+/UWxVerLZa+TSo0aZjm+IWbm/8v0wzATydAYVrvAVUcmw0buboYYlS2S7fmO0/lr4Ie72kF91pg7NXnMLB7Q1rzCe0DfYDni6t7mgxMKkI5zk3bDnUWxSVglguuzWOplG2l20Zg2LByTtq9pf5qy1ETigRTm/LAsPkVqB66eSS4vWhftK8GF+3zdrd76AxniTz6aKfgA2n3rLytYM7jrLaYI0tsv9aQv7rr9Xj6aqlPdeWZ04V+1eENPck3CIWponXuRLiApC3sWXCQL3cPPBwdPBb72JWftebbN7yXYqbywMnXd9X+KMK3Nk9lR2IMTWxHqoN5P2jubIeIlryf3UbG+M9bKN1XUekbR5dTRWyWycH9i3z768O6Wv+e57jgVwuNyf1qwGBrRuhBixVvaJq8BXM2LjrPr2t0vjLPhs0y49ZZqBlj+Q3g7tbSX72M7CvbQ7kQjoDVXMbODCkPxX6Lic6ks0H2jOUXf16qTJNF2hDul6+up69n4WMwcn+9Larkh99umrq5MoMu4gFNX8qNKcTzlHKZaRxZE4KVFnSI6HoHd6FqdMh1tJ2HxceqgFZUWQd5M+hJkJWlqdL2b6VLK5fId9Wr9VioDjdgrLzE9v79z3/tUxPF2XAhIon22k0kmAr8JpF2IIi0Mm9YHvvQWM1pneG6XSQTDYXxuG1o9ShQ4Rk+IgjsspXf56NYUHfoXiOVW27KmUgLOF3QEG4dM4NcilDoIz+1q1hNUADg4gQEyOecJWKBGXAuYgooKgGuTvARYsIuHRGEoJr5yS9UAHnJqWl1Dov86m/iJkNaBcBnnLkGwm96nJwzniTQDUZFZgOLXNEpsgBBhyDsu7Xzus0Xi0WHu88dpScH+V1z8HFw8ebT8E2b7qyqJVjlB8qdSIUZ7RKK7CpX4W446Rx2eq7pU8ZCupo89OvSc5v2WrX+3/06lke7Re04SGOMpbVVu4fVL8VvZvUly1n5UxcAbArV6dzjI23KbnW8WtFr/xuVw1uIA+9F23cKdTv8xW9fW6X1dWTtXFVn7ukP7YL8haLsXect0j578jfArfIUkJ0s65IUcpaGW9FSKsehqlwToKW2drHRxq3Vv3dvCBN5DphVsXhwxSJ/IOpbhdqsG14E+pcq3NYrP1NGAL5/KY/7L09eKJHWnyYT3aMZ+w9X/mGD
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: eJzlV81u20YQfpUFL7UBiXLc9CIEQZ3YDdQGSeAf9GAY8IockRtRu8zu0rIi6JYn6aP1STqzS1ISJcqy3EOB5uBI2pmdb2Z2vpmZBzGYSIvcCiWDfnCdCsNAxrkS0jL8XBiImVVM44+gmU2BxdxyZlKuhUzYzYDFhfvE/QE8RimXCTBuWAwjIVF/OMPTI6+nCh3BMVM64VIYTnaZkO7iSEkDaHZYiCymK4eZisZh0AlUDtqJDmIEaUA/iAgugcfneOeVh3IjUDDnmk/AgjZB/3becG5wzkZKe5g80QATtIZKgg6/FaBn+EWiPn4lobNKBq12Ag3fCqEBAVhdQCcwUQoTHvTngZ3lpGIswQgWi07T8FkUgTEYxjFIB4EX6K+0InJOtUDgTuualNbMj3hmnmn/y4CNYVabVrqMfJvlXPwBsxcaLaNNiRUyFg8iLnjWYnAp0Aj1881+whuZGjm7NhU67uKbsLO1B9eCwol/IenPOqF7Xpb1m8uPdQTakPxkWKYSxcSEJ7APrI8oPSDhG529MFKXEKNqZFkFtFHYOyqjLrnqjiaa55eIf5bfPSG8V3FbNCJ/9K86vldNrMq0uf0kljuSNjkRnaHz05MT+m8d3+cxXpoiuzkam6MHwettckMeY2nlhWU17W1RfEWKSK2WyA4/8jzPSuLpfTV00XwF8NKX2wC0VrpMhft8vmIePSmdU8OvGAoiX008bYV3bam9jAM2FUgcSnjkkzzD39CzxZbrN2K3ohK82+L4gv51miUoy7R9h3gjNL/4mP5PQzNAe1ryjFE3xc7uzDRihEoGImzvduba6ZnvC/3bOyqqd8A1aCpc9wt5zRPquwF1ZVZyBEUDYaSKOncCLhicVIJe2cd7xCjdkneCTuABbWvg5zBRJV6UK7D4+kFqbW76vV6MZ11sXKFINJc2FKr3cBpsFv8VgiR+a7nG+OMtN90tg3FFb8KnsgpJnZO6dzoS8dFcssgazQXNnFR9en08CNk1dpAHnhV1Y7tfu+eeeTNsUhicnoDlGgevRxy8psKmKOwgsXt2JJUF3480F5kLQ85xHOswCJOwcW2flYpvZji0UUS6CO7tfYhRXUv+PBi6b78pPeFYSMHvf15v+rY6A+XcmAqev6nETKPgeiuoI+gKkWLojQV1kVHqiOYx4iNVVTSPXEVj6QpKrynyXGn7a53Sldnjw/Kn9bewFN6onlqJHf39469jmpTxxU+xLZi0OQfLmOFLE6Mynax89uixwpkHdMgGluZsgyfZqGsUSoNIcCyO6RHYWafU58MMh2RkIPoZO02HZm6RCItVPOVZBtYZMyoTMcsVzu0QpVLhgIG8gymWeIGf1CVMWQYPkNGDIuZx9MSH+CZwQKFL8AkqTCaJRwq5RXCJkF3CnHsakiJz/hjKGWejIsvo5cYIh3BOuJToGwYVKRWw31E6qirAR4eP8DQ82Yj5dDoNuTsOcU7qlbqm93Hw/uLT1UWXdDAbGJZsLXmMaidWUUHzelVdRCM+X6cnp6/Dn8NXpJsrYxHdCh7aJLZMP/E66daN4r+6JZX1YOHR9vKMIwEtyvDOS869rXYn8m6VdZHcUgwLScznQ25ovFws6Gc/BjkuRiCY2eWY0xqfo8uyVR6ztp1rK9YxMemW1ctxH554Ot8bxtNr1w4U69vXoQh2LF67bFc95ECzbavXDpONDexAwyuJ33MP2wFp2zp2IK5DVrF9kTU2spdHbo+97InqaVnPDn3E21azHQjKDe1Aa08uZ7vqpn1HW6K5oy/aNVM/yVZDGnGcv4eII7crWhuLwWJ1qv1wQeMOL2eh5Rw4djVcfqDbqyO5WtvNkdBDoL8UuK0qb4hXkCHe1uL+pFWhHqKqYkcHcLz/B5Wi8Kk=
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: eJzdVs1uGzcQfhViTzYgrRw3vQhBUCd2A7VBYcQ2ejAMmNod7TJekQzJtawKe+uT9NH6JP2Gu5JWP0aRSw/NIaaWM8Nv/r6ZVZKTz5yyQRmdjJPbUnlBOrdG6SBwrj3lIhjhSOJvSWKSX4ucglSVF5nRM1XUDiLTZbw1rpBaecnmhNLxG6Q8wdq0VlWudCGmlcme0mSQGEsuik5yvO3JPauMvuClSW5xbaWTcwrkfDK+X+0hvdPqWw04l8LMhNTCTL9SFqCl+NbKUOKsoY9fKrd4YZA4+lYroE3GwdU0SHxW0lwm41USlpYFfXAAmDTNAwt7y8g935+fnfEfuBLgCh+ltZXKIvrRV8+QVj171rFvQbXaeL/3yAbpy1CbMFR6mMsgp9LjciYrT32g91CGaGUKU4c7V+GcVQoY4BBA7r9z6MsgmRk3l8Cc4Ewvcm4ran/sBnRyeY1oJk3/sSPWdpU+R1HBsk0P2b/qfYyS8T38G+yFJn7aQ4eycwRj9Ixq83WWkfezuqqWsF2iZGKVrFjxbZurXf0pyldpC6ybqjqi+Oa7ktzPEjln3EeTEweZz5e95x/2HdxP3FZ7Gzk0IBUR5SZp8Kw5Yv5ItLd5/nDE8aY5EuE7LetQGqf+oPwgND9+Z/3/v0IzwXtOy0owRZET8Zm9GEHJU1Y7FZaRrS6s+pX4+NAMVskHko7cBQIcv7DXsmBaQ2EjoFAS1848K5jjkABLaZgTC4oRYTYbJ6OOIUfgkxFipIeRG1pQxzjykuamwwy5mhs6KUOwfjwa5bgbSqtSVTipQ6rM6Pk8Yay7Nm4AlEn7FTO+vT5i6WEbkBuuizad67Bs8iLbDx1vtxHdMvdFV5Kxzg5Y5OJ6Ip5oKbhwOYptOabiFlPnWVYYD5gNPIIed+w8ivYZMa89xhIJ62imXsArCxVKCEdI4lGcgJ8pGggOAy+GwcqMTgeC0iLdMzsWneK7pakdR2QIcO8fU6bGfgGskmn89fOamH/5/fbQt8hwGL1PpFGf3q/htZY6zDxjd0CITQRjM3IM28eSTaNx6hKuV6VnZt3VMotdjfZVnF5fW2tc+GmT0t4w/bT9tFsLW+GDDtooiZO///zrlDcLKW4WlCtfCh5/gl6yUuqCMMtzgUpTsy6doqt6eNw2SComgfcSj5tqNvQG0qQK7BtdKw06fTmtsH2AhfgzBusAb+aqUAGdvJBVRSE+5k2lcmEN9hvKSm0w/sA9SLGGAc65FJoWosLkqbigmH0iRckpagKdy0ZQggbJZPHMgF+U1IAcExbdc1TUVfTHc86kiLMLajngMM651Bq+8ayHs9pHvlt3AYoORXienh3EfLFYpDJep9i9Rp2uH32efLz67eZqyDo8X1WodpInuHdyk9VzBGfdXUwjbb7Oz87fpj+kb1jXGh+AroeHV7T+IrhfvL1B8R9vlF2JB3oJI1tJcErTRWzVsej9es9kyolr5ppJQVglXGWR1YrXMWw1TcOfsWi6SOUIkXSxrlq2BS6c883e9moUTr50A/FUvLq4HsW+ZknNFBk5rd3dnphEu8W2wYhZMyfDau+YQGzoaR1M7KY/aT5dMQfJjqC25PwUybk7sPWjiPZ5uoXA//NEOaryjisQdPl+I97evKqwYbbOd3YAc/cfdbRppw==
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: eJzdWNtyG8cR/ZWpfQlZBSxISLJjlMsOL7KD2CUrlGi7SmYVB7sNYMzFzmpmliSCwpu/JJ+WL8npmb0CoELlLdEDtZid6enL6dPdu4lSsolRhVM6jybR+6WygvK00Cp3As+lpVQ4LQzJVEiR6NwS3hhKtEnFXBshc6HyVN2rVMksrIhkqbFNpNJJIReGaIVDsXi/JEPCLnWZpWJGQuckylyuZmpR6tJ+WnopszgaRLogI1nbaQp9LZl7ldAVtJs22678cV7D/kIauSJHxkaTD5sdc69z9bEkMb0Ues5X6dnvlDicUvy2kG6JZyhI+MXGnNW2TFm0oY+lMgQ9nClpENlkSSsZTTaRWxd8xDqj8kW03Q42QeISOpFpZf46vAgmn58PW/0/T/hgx6ZWDuyKtjcsyhZ8jeXT45MT/g+udriXH2VRZCrxPh39blnGpnNbYdjjToXTVYSChzvKNI5zymW8cNHbuKvj2W6o6bGAllCxeXEkrUhprnLgT+XCMTBnpcpSGC1mmU7u/mSFLShR80r5Y8apFBYbMhKX3XDV0FuV1jHwpLh+M/379Wt/mzOSwa5zcdQHLJS7VxaSBx0MHsOYx2Gu3VDlQ94/kxYGz2VmqRu1D5FiuxthV5Wsv0rLoLJOOooQnL5/Vbof4UGERFhJxCrCMz3KVeFd/MWrl1+ejsdj+nPyZfJiNnuRjJOvvjo53fP2Tz44Vqzkmo0vpOWknsnkTszWwuoVibO30ybtrXhQDjnqOCOQGkdvfzgeIBawmX3vltLhD62FNOzJ36LUyLn7LYKXYoqx0ot92I/g4bhYkxPWaVPHlETtQdyVIgTZGlBQCBK/NjK3CrG7ZPl9qcCG9hKX8p6VuGoiNYPeag4jOQyiLLwx2PFOLXLpSkMD/LiXmUqbQx1GWlDO9EJp7BNrJ+UPhOZxOL8brnRKGVZ7mNsLAyDYRyXj9WGpkmUD+iVAPyMw50LdU76nQq3wM1Sptx7UojEcrFcHoQP7T+kEnZ9Uy0P72fCVp7Nx8iJ9Sa/mX8RxvKfohS7WtYJ1IrIyS5/M/olhxa9VnmRl2oLK1rH2qKLc4tHCQOQ5oOWgAbFqARp8QBu1UDkYsy1WbKXqUvJ/8njLuwd93qHlh6X2XmU1uboytfX5kC/XhZvmnVtnWmck86f8GarEzr1Ym3hvtZb4mwuNxEI4kW64xjsuFt8xhR3cDnZGhQCzgy0kEifX4gi1md2H3H/IkVEFh6hTw4+9AwPLPRsSwSEH3eclibki5GmvLfEcE94mS5kvONBzlPsh4jqcywT8MfX8s2KWl76egPU46hWjiPNzoZylbB6Lnz0xeHF2gt4kaDQqwI0MmJU2HXTZUaMw5eWKOb8+wQwfHm624dGfeAaMGp46UDRbXHtS5RRgc7PMmwNSK/GzSpmdAsuJ0MGcci3476jJs2nObRzCPoC77thibLxHssyVnGUhnUL6DFG3NBz2/vxyAj7JfAUOBbixQIQu4luPBFQgbd4amqMO50modpUjpDFyzU2Xo5U91FT0/VAVfQq5X3iRzPXhChQqRDmzzy7T4Ri2o6fwVuxX5WrLs3G8p/IbtHu1jythn8zw/ulL3wbZ2kBguU5aEBdXQc9V9kdp3XWRcvX6DKEHem5PSO1lGeSikAbB2/BvsBMjv7TL33uCO7RiCC6kew5bmQAOdl5mGYMgtMjsdhb5MnSrfckzybYXKPRNc3/g4OlntbldRABO2lwgHzmo/HzZuf5m1/RdsLSn2yCAeWjhtWxAAsu2B8QfwFiLq/MDhlfh2J1rZIkWzqh/eCrqu+bVZ04A/1+umeI+w6WeR0cywl+z46PAV6VRbu2HxrNC/UD8eMOT3Dmh8TVncLBfYavlgqfLBvLV1IM3UGSpeVBdkHcHT5STaFSNraM2IUYhTUZMVcOmCxltdlrQLRcWr/ihcfaSVrqyC/tKw/Vk6VxhJ6NRindDWahYLdBXu1jp0f04Ynv6Mt7BGCb+J8TY8PqApJvWae8YOyHktetasg8Lg8MD8VkF20DEexUQUwpXKwY33FFBNvSDvvrVHHvbk3MrwjXN+Mc1Qz2Ce3wNvA06iltxBC4lL4Bnwsy7oZAJYfyheBHviJ2I6uDXa10a9sgQyn1z6zufLkg20cz/+q4uFn/75f2+bZ4FUUHv0GRXI5pXL0iqdGbO7ykhGg/6hPWM7w9ETTJy6PgbBDw+13XmozHyGYmuiMNry6LQxv2lCWkbEvV9u9THQrt5L8uaQ+LoX3/885jLCBqDB0oVunY/btBjaNd8TxFajBBOUSUHLNbIDTK+gSutL4DZfGg1dhN6DIGXAIFbD7otSgKm4mUUep70UjT2jntudEnk/GVWc49XaLQylCxznekF+AkhziGAYy5FTg8iQ3XKGFDMUJ7G5AyYcGsvBBDUCCZvTzQ4SEk0NSFg3jxDizI0RZZjJoWvbziWQh3WcyVzjJo89oB6MaJ4TqyzAKADCMfxyZ7PHx4eYulfx9osRtVZO/pxevH6zbvXQz6zbT/DtHHg3El1UjKP1NnFNBLiNT4Zv4xfxKd8FsOBg3YdffhT2u6EshPxTj35H/iIWGWGo0c3KjIMBWy3d/Sm4ugP9afFqDsG+u9ytfk9psbCZPdzARgRJjgWttlw/3ltsu2Wlz+WZHw9QQyk8cANdK4sP6dNo/qkj4+uqqp8LJ78iHnQypqGc+ZgT5qhYb1jlt774rHl8aWimP9awf4XySf0Cvd/4oNooyvXrLCbObNwnXd7jcy2W4O/f820KytObuvRna9H1QNbedBHu6UpqMB/WaGDR77mpEOF+KbZHt48eaAh87CbPXODduTfdF9B6w==
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: eJzlVsFu2zgQ/RWCpxZQJNebvRhFsWmaLby72C2aFHsoAmQsjSU2NMmSlB3X8G2/ZD+tX9IZSrZlJ70XaA6ONOQMh2/evNFGVug8lhCxkpM56IAZmULplYvKGjmRN40KAk3lrDJR0HMbsBLRCo/RK1yiiA0KfFAhKlOL0i7RC7WAGsXc+rRofQ1GBeCIubghy3DXIGSlgtOwFsokP+fVEsq1qCA0Mwu+ymUmrUOfIk0pYxnQL1WJ7xGqfwanXHL8KYcnD4/BWRMwyMlGjkcj/teQA3q2bLeZPB+9YGNpTUQT+RGc06pMsYpPgYHYyFA2uAB+8vi5VZ4h+yjRe+svbcUnpec3A/huMxnXDilRO/uEZaQ9zvMNourSOXjTS7+VcMYaPcd7gIXTZDsfjbZPhD/4BKqFqYcu8jVUBKRro3DgYYGRQm7577TCHwy0sbFefaEbZSfQ/Nrh9ZNCM6XzvAEtmGfE2HTMCUbkFLBsvYpruvRGXjj1J/Lj7TbbyNcIHv0FAZwsfGuoA6Mz5CujQWk0ljldYwID2EUWPcOLYRMVqX9Uz+8ut5AOP07/DS5snzrta70mWxOjC5OiqGjtDJzKVe3BxFzZYjmWnPJxjGvKlxv7O2FCt/xEpNsDLtdMj66qO3T25YHOkFFtOWwClt4MlYXeL3pmdiidlufi3VTc41owf4mdPSs7iVmCbkl65klJ7o7i3InuGLFoQxQzFhqcqwfSoJWKDW1OKYk78czY2Olb9KB0gsFBic8zgXmdn4SdiN7x5dq2nhE5o+Re3eWE6hEPNnKW3n63fgHUU/KPf28e360sMQRSxXs0RNMQdul1kfqcWSqPkhB7BFNPMobdYXLfb1w6ybRVZm53zQ1lam7qYsXlDa1z1sff9iU9lES9PZiOuXDY/KiR9k7i2df//n/Oog/ieoWk+A3pewSaIGUDhuYBmEowu+d9OUXfAXRju1R0t1xMI4+MQCt6fha4F1DVRtAikSCus94fZppGDYkRm2m2ZXRmpWoVqaFXoDXGdFiwWlXCWRpBWDbGaluTBFGJDQXgmoMwuBKaZp1mQrEIJaWCGXEirlMQoqClYnYjkGRGgaGUU8HS9TzWrU73CVwzEPNWa2ZuRelwngswhu5GoJK6Io0rLseuC4h0RMJxPnqE+Wq1yiEt56QQRe8bir+ml1d/X1+dsQ9Vg2DRR8UT3DuVLdsFgbPrLpaRrl7j0fg8/yV/wb7OhkjZDfLhcXs01YcD/ZTJg+Hxw31M9B0R8SEWtJkkaNsDvOkF+OPuE4M/PYaKncmBCJPWNYQSb99sZhDwg9fbLZs/t+jTMCB0wSdKdqNhJ3Ws2vesiKnjHUt/kq4kjSeTdjscE2+vWDSgV5SDmt4nNe0fOPpuyawHsU+FtUuBf3kEPOnykilD+vZqv71b+a7DXoq63YzuLc3Lb806qAY=
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: eJzlVs2O2zYQfhWCpwTQSo67vRhB0E2yDdwWbdDdoIdggR1LY4kxTTIktV5X0K1P0kfrk3SGkn93c+ypPtgUNTMcfvPNN+5khc5jCRErOVuCDpjRVii9clFZI2fytlFBoKmcVSYKWrcBKxGt8AiVACOsr8GoAGwv1BpqFBBEhUtlyFAZERsUpTUByX/RKl0pU4uFtuUql5m0Dn3ynVMGMqB/UCX+TrF/O4o757Bk7DE4jhTkrJPTyYR/GrJFzzt9n8nLySvepPMincdLcE6rMoUpvgS+UydD2eAaeOXxa6s83/6zRO+tf2crPimt3x8hcZfJuHVIOdrFFywj2TjPyUc1pHPwpofRlCDDGj3He4S107R3OZn0z4Q/+IToCaBjF/kWGEjXRuHAwxojhez5c16sTwba2Fiv/qQbZWfQfD/g9T+FZk7neQNaMMXQi3TMGUbkFLBsvYpbunQnr5z6GXl512edfIvg0V8RwGmHbw11YHSOqcpoUBqNZTrXmMAAdpHFSO4iNUnRpZ951ctMDjmFdOhp2u9xbceUya71mvaaGF2YFUVF7y7AqVzVHkzMlS0eppJTPY1xQ3lyz30jTBhePxPp7oDHDdNiqOYOlX1ZYNjIqKYcNgFKT4bKQc9XIyMHdM7LcvVxLla4FcxbYuXIxlzckmg8gG5R2GVSkPuTOPdiOEas20CqgoJUbKkeSXA2KjZknFIS9+KFsRFTgOhB6QSDgxJfZgLzOj8LOxOj4+utbT0jckHJvbnPCdWT+ndykZ5+tH4N1Evypz9un96tLDEE0soVGqJnCLv0hkhjziyRJ0mIPYKpFxnD4TC57zMunWS6KrO0u6aGMjU1da/i8obWOevjD/uSHkqiPhy2TrlwMH7SQHsn8eKfv/5+yaMAxM0GKxUaUUEEgY9lA4b131SCmKaWYznFyHy6sX1QdLdczCMPkkBv9PIiWLJGVdP8qJgEcZuN/rDQNDxIhHibxlNGZ1aqVpEaeQNaY0yHBatVJZylwYRlY6y2NUkPldhQAK45CIMbofEBNROKxScpFCyIE3GbghAFLRWTzUtL8qLAUMqpYOl6HutWp/sErhmIZas1M7eidDjPNRhDdyNQSVWRxhSXY9cFRDoi4TSfPMF8s9nkkF7nNEuL0TcUv8zfXf96c33BPlQNgkWfFE9w71S2bNcEzq67WEaGek0n08v8u/wV+zobImV3lA9P2GdG9zmHj8bFf/5PYOR2xMdYOA0kJv0IVTdK6Ofd/wPWmjHd2SijrLsNXZOtum4BAT953fe8/bVFn1Sc4AGfODVo+k6rWHZXLGmpZR1rdtKepG1nI7I/1vcP19z1MErCQQ5XSQ7HBUffvTLbo9jnyjikwN+s4c+6vOaak0C92ZsPb77psNeSwZpBvaNB9y86HXhW
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: eJzlVs2O2zYQfhWCpwTQSo67vRhB0E2yDdwGbdDNoodggR1LY4lZmmRIyj81fOuT9NHyJJmhZFv2bvoA7R68EjkzHH7zzTfaygqdxxIiVnIyBx0wo6VQeuWiskZO5B8IlbC+BqMC8JrQtrZCLaBG8bFRQaCpnFUmCnpuA1YiWuExeoVLFLFBgWsVojL10HNufdobRs4pHg6NBgErFZyGjVAmuTmvllBuRAWhmVnwlYAgVqg1G1QQQYQGPJ95Ow25zKR16NMhU7qoDOiXqkS+2++DBN7T0VM+mRw8BmdNwCAnWzkejfhfQ/boeWW3y+Tl6AUvltZENJEfwTmtyhSq+BwYvq0MZYML4CePX1rlGehPEr23/o2t+KT0/HYA+l0m48Yh5Wlnn7GMZOM8XyCqLp2jN730plQArNFzvDUsnKa1y9Fo90T4o0+IDNHQRb6maivj2igceFhgpJA7/jvnxa2BNjbWq7/oRtkZND92eP1PoZnSed6AFkwz9CIdc4YROQUsW6/ihi69lVdO/Yr8eLfLtvI1gkd/RQCnFb411IHRGdKV0aA0GsuUrjGBAewii57gxbC9Cu4s1dO7Sy2ks0+zf4sL22dOdq3XtNbE6MKkKCrauwCnclV7MDFXtliOJWd8GuOG0uXm+06Y0G0/EenuCMsNs6Mr6h6cQ3WgW8iotBw24UpvhqpC71c9MTuQzqtz9WEqHnAjmL5Ezp6UnfYsQbekSfOkMfcnce5Fd4xYtCGKGUsQztWa1GmlYkPGKSVxL54ZGzvdix6UTjA4KPF5JjCv87OwE9E7vtzY1jMiF5Tcq/ucUD2hwVbO0tvP1i+AWkr+8ufHx3crSwyB9PIBDbE0hH16XaQ+Z9bIkyTEAcHUkoxhd5g8tBuXTjJrlZnbfW9DmXqbmlhxeUPrnPXxp0NJjyVR745Lp1w4Gj/qo4OTePb173+e8zgAcbNCmgVNJ/K4LhswNCnAVIKYpuZ9OUXfAHRju1R0t1xMIw+TQDt6fhEsWaOqjaBNIkHcZL0/zDSKkrSIl2kgZnRmpWoVqZ9XoDXGdFiwWlXCWRpOWDbGUm+RAlGJDQXgmoMwuBKaZqBmQrEGJaGCGXEiblIQoqClYrJ5aUllFBhKORUsXc9j3ep0n8A1AzFvtWbmVpQO57kAY+huBCqJK9K04nLsu4BIRyQc56NHmK9WqxzSdk4CUfS+oXg/fXP92831BftQNQgWfVI8wb1T2bJdEDj77mIZ6eo1Ho0v8x/yF+zrbIiU3SCff/uQOCfyYHT8Vz5A+j6KuI4FBSLh2vVl2faq/Wn/WcKfK0OZp+oelJsEsiFo2Xq7nUHAW693O17+0qJPA4RKQiczP7pxstdHlvoHltEkE47HRdK7pKdn03k3HC3vrllpoJehowQ/JAnuHzj6fstsBrHP1bhLgX95bjzp8pJ5RqL46mDe7XzX4aBfnTWDe0cz9hsBKs1+
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: eJzdWF9v2zYQ/yqEnlrAkd0sezGKYmmSFV6DNmga9CEIEFo6y2xkUiUpO67ht32SfbR9kt2RkkxJDpxuwIAtD4kk3h3v7+/usolSKDQk3EIajWc8NzDATybRorBCyWgcfZ4Lw0CmhRLSMnwuDaTMKqaB4985MKUzLoXhxMCEnCm98M/csETJmchKjSzT9T5q9w2pDKD0aSnyVMiMTXOVPMTM3V1dOWAomEGcxYOardBiyZM1S7mZTxXXaRwNIlWAdsInaFFkQC9FAp9Q14/BxUhXcM0XYEGbaHy76Rh9I8W3EtjknKkZ47KlNPIKopmjTND4JlEOvnua7/Xdg0jDt1JocqzVJfrVJHNY8Gi8iey6IA5jNRobbbd3RGwK8oKh8+PRiP6gWyy6hR55UeQicbKHXw3puAnkFZqstsJzt5TFd2Fh4Q54nn+cOWsrBdT0KyS2peqtN2cQYQRqc0PfoOMUarK+0Tk+8xLjIG2lWYR2tFURad/cboKFcUGPR9vao4cYPyAVxaebVSShRXlQgyVlCaxchu2TZtBLSh8WdO3ptoH3DvJc1pTb0LUH2a4cKSPabS8O436E29ynLXqGdTBX6a5amxppBbPgxqyUTveJb1OC5NMcQsKpUjlwNHKL2iqRJleVsByM+UcCydeZkFdYQGiR0/wcZkKKGgMOeRKLvI57EQhhaSOF0G4KHviI1F3IMGnETOyClwv5gPL/VUX8lY7l4uZ8wr5giYPtZITSZ1ja9MLzv61R0ogI9al7gTAG4ZLoxDvNpY2FYqehBgE/5QD9DPpBt8Lm0IGEi0eruellRKLQ/5MFz+A5hpwRNRNEXkHMjv9Z5RYKKH3NYRaoZytwicSt+xvuZ10fsLvbsWW4SgpxuwVaiMRt5zryDuy9x3t8FyOXEsHJ6NUPNZ7wftAaM02l1Dzc83lwW0+fXoU33Dtn4MABmWux8MgXBaXGyWi03SN+jwMblugtzilCFqVlTc/3Odh1yI2kqlFafIe055qff7An/79cM8H7tMTip4EKK8Fd0/GRb5SlFnbthozTQrwHeryjWn8LXIMmUHBfyGqe0ezVqnbyhu9GeGkGzhmcWKJhNcoNO7OYV2jfEHcOC1Xpi3RUNzi0WVuY8XCY4tkRL0QssgqvhsvjiPTsdHRUkhD2CTHGH++RdLdzxjXlhA9l7ZImJtx/eGKkPK3Scd8ghqdXE/YAa9Zu/jQ1A1vyvGyGo/uWnHvmr2GL0lhqJ9hsZuIRgXwl7ByJnUrsnr2QynpQRwQWuXNDwRN4OXBjeEfsmFWMr9eq1OSRI1TuzX1MaBcGfxNN3duvbk9AO3778rlvW5LgYICt5QEko8GjVs9LqnSmRaClBGs86ArRDQqOIWqKjEIXUa7SplJXNE9cRWPpCgqvKYtCaftLE9JdSJr+1suFHXGvenZN8cWfv//xklYazq5XkAozx+3FcgaPyZxLhHcu09Zkwaq0R4vVUqBtMZtY6rsGT/LZkaHGBCLDXcr1V7seVPw0MQVt1wzwzlRkwmIVr9yc4C4zOEimrFDYxyGZS0XDDSCxG7ko5pxJHI1zWEJOCUXI4+CJTzEn7NoJwRRUtPQheaIQWwSXqLILmDNPQ1bmzh5DMeNsVuY5ZW6K6pCeCy4l2kZ7BxqLexCFo64CTDpMwuN41PP5arWKuTuOERaGFa8ZXk7OLj5cXxwRz3Y3VwTDCdZOqpJyUU9ZKJpgxMfreHR8Ev8Uv/IzubGoXaAPLZPdjbCzbzRd4j+3PldVYuHRDoucCzfaln5G8Uh8Wy/VtGx3oHuOziKKzWbKDY022y19xl1au0aATubaZaZvCzXiOfBGOX7I3/d/iNCnLz5VvfUlO7Co77XmgRC4v647yMQD1wU8DaFQYYOzXsvfhv3q3cXnaiduI/yDQ/jqIVi/uVwHsrtg71Wg38Go3GZ5TWmMmPumIfcnTzI08OipyR80SP4F7SZVzw==
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: eJztW+tu20YWfpUB/8QGdLGVONkKRbG+pbXbJl7b2SwaB8iIHEkTUxx2ZmiZFfRvn2QfbZ9kzzkzvIrKOt3+WOyqKAKanMu5fPOdi8hVEAkTaplaqZJgHNzOpWEiiVIlE8vgOjMiYlaxLI24FYwzI2cJt5kWTE0+i9CyqdLMzgULVWIETNIiVDqi2zxhMonkg4wyHsMl3lB6xhPJcT8WialMYH14Ul9hksk4ksmMTWIV3g+CXqBSoWnKRQRCGqEfZCjekUgX5Qanbvo17X9TiAmzU675QlihTTD+sGpp/C6Rv2aCXZwxNSX5SCuYJfFpyu0crhOYD3+F9R1AlF6gxa+Z1AKksjoTvcCEc7HgwXgV2DzFKcZq0CRYr3srt+Jc8Ejoas2/9b3cJyf9SpevW7zX0qlaB/QK1h/dUsLYExXlOB8UsbAlXvI0jWVIxh1+Njh9Vdso1Wh6K4Wh+6VRKxlKe1lpY7xRt3xTrGM2E4nQMqyBCCXhMjGArFDnqVUzzdM5DJlzM0eXGLUQ7IHHYAAGQJwJQIpmS2nnDTCGWgAYIjbJ3YxUywcE7L3IHfAUzTO5sWIxYOza25aWQKwBQOYqMmN48iANotPjm3DsZt+0sD+4S0DJxz487sukD3DkE27ACFMeG1F34AdAUh4rjm41NQM9gDmm3vw/kwStm1fltI67P4CNWk9QRBGd5OSQBbicL9IAANB0pIw2UdQL4MguOIAigGvxCBPJny+PXrw6HI1G4k/hq/D5ZPI8HIVHRweHG+59SzYxbMFzNgEPcIPcMeHhfemV46uLkl0MOVFllmgiYntXP+73gBLAmOgPO+cWWSFnXCPv3AWR5lN7F/SYHIgB3Km8QWOBrGAqy4Vlxipd0UrhFtgnYiqJcyYepYH98bnmiZF2gGeo8NCTLbMaDAbrDTPcwpZAa3D2/IKleIZ80yOegxMdIl45Iv/y5u0bBqwmeSyNo0ZA/lSKODJs1eH4MYOte2wLJDqeOmx1PDgGTEx5aDseFVDqeHS5ND8Qj/VYiTI/zCn53rnWQeJaTIUWSSj8EHd4bsHGjRvNYesBu/EWaZgpknDu2MWUXFudfzAvkYsjAQEOQ3/ndo5YQtt3Q2IPMTGn1Ql+8NCNaInEDKgT48pMLaTFTaZaLWho4eYJQHkq49htA1gVesl1ZAhcXdT5b+Al8sv55PtQvpWXr385v779y83lN2CYDcDVWGlaCoP0Seowtzg+a1qs0sikIgTXOvYUkqhuEzxIhJ0YQPU6eOzJep5Ho6Ojw29KNUYHo4OO2LEUcdy/T9QyYW7BiiuWEDDmnsGLpGXA/grYiVzoAFq/PTkbMEpvFnI2t6i3eEzB/aA2RROTpanS6Nm6MkVcwLkAhYLcOKySyAUcciPIttVsP4ElIhTGcJ0P2ga6+mOI5gJiuAaeAUKroG+qMwNbGk8lBeYhOfOAJl9XB9FxYwvzfcLDI3BkSGbGMcX6jqKF1G5dOEF4OrdoSnHqydryw8kofB69EEfTl11479S7O3lAvQkAmMJORMnAFEGqhzCyyz8tZQqqfLomHShuYIv7FQtawlUoDWUm5Almxs4lIPCCz0SvdnqFDdvylaH/yfJFMhpDgjT+7eXP99MuU5+IkGcUOSFCQ8KILKGfYeR0C9IBgRMRznkyAzuCOBQQiHkcK3M4CK6EIAr2wbA234V5mkYHyeVjQPG+KECaJps0XVyaAveCfShaFqTms0qXdFSSU1ESK3WP6M3SktFyj2aWZhNIhilprPElPoUawuYdQiUq6T9FsLAhF8zDIVQUFak6mBVLAtNjkKhBIg4Pk2wxwRgLybiMGY8iDYwiDBxMZ0vAScJT0Nk6s05gNYOmbjL9H2RhT33W5TczoSHHTsrA0lCkbkfNCkfgRqAeBwnvIcyWARQQhqCCEgyeI2VtMKaD9rF5OrQrcTZAfXZ9/PqWvb44/+lszG587DMkiRYx7WfmMgVd7VL4dIBnQOra0V7NsEnkdffVlgtE9aQAPB4CWxkfe+B/2EM88MQVzr72Y66khFFXCiwwiUUZt+5qqtwFbIiJMKwwA9a7CzYMVQXl/4CkYuJXKx9EgaXN8N7MB5HgyRptp3n8zHAtSODe39QDlC+w9q5fn746OjzaR2WqouXJCkC+8KJ/cNg/PLo9PBg/PxgfHPyymZUX6xYnwEsWZhqCnYVYUjus0iTPLB35At2FO41i0j5zlQauJnQfKis1LVK8bZlvTZuJUrHgyTZ1fOm4WdCDUQmlmMu1AvUSwm8spkAAMU/ui2jSkQrQbBztZEWpqxzg6RbXvkTesPIb7iiGtqcmAlsogGu32L4MtIpyNY/20jcAdjggd+VmdyQDUCJW0zUJqsz6Y6lOl91/R5n78mVHmXvMTL6AJA/7GAVfwLGkOrdMr4qDU8uwWrYfsPeCStsKgZ8zY5294oJnXNrlexcl7+xxjLgy2UcLlcOqzsWe4yHIIVyuqsuWBrF8o1HXw+DOZ1qIBdyE4KOAuXPML/aBXeC/ZhujZu1eqwVUDDYpbkBcPTo42LWbdu2mXbtp127atZt27aZdu2nXbtq1m3btpl27addu2rWbdu2mXbtp127atZt27aZmu2mjq9Q2yWnzTbNKUPeSGtzJQkyGpxkkbWBQ98oVsjmu9cL1pJpLTjhWUWlGx9C9LNYx8fCrmln1dozQWulTsDWCAK/PattvdNLa/ZNqdoUvwLKYkZQlqECzdcfyHZiscHjSofh63WH0d4kPSr+JqMM0L/6PTXMtjMo0nEKk6anKkk0DHX1lI/R/y0BFCYUxAnN22qZlI4xoAshJ2pze0jxO5Y8CLz/iq5MnArhLHwMC6Q5qzWf4OmfQTGnQHgvfEAhAMnr7EycFQ//W6LDKb4aOQIaeofr+z1XrNc/1sN5CdSp0vUl6JhbKawjjMh3Dvbm1qRkPhxE86/NUDiSku4kdSDV8GAWoWau5AmoRGXcvY9zjjpU+Vua7QRQ55xdGLL3I3Y1e97uox/6EEyo3I9HVBaXYyANY4jjwUqeiKmwxCn1qrPOJuW3YAuMNdmohbMnHog/yycnIPrE9OD4u37caChAyQ8pDsQ8VyQDqh+ayY+YnfpvD4UOL9EG47z5RjlqHyyqY0F+vizh8+f52UzcKGL5S8K1kEs+t5GXGVKchBCstSEeX8i2aEJTHEl2Hr/8GeMivq9dwz4tj1PqdA3vlX2qCl23jsk1Tm/6FJl5Xy2xbL6yze1Tut7Xj0tFK6W5oBNt+RejsEXRXZs2Sa0tREjR+l9iau385lfYpcj1zrSeEGyng9twOYYC9iCIU+O4O1dtIsa6p9+fyZFcnU35f3WpSQjV4g3bLSWzvn3//x75rj9wsRSShfKI+mnj0rZR2McU8WwLwFRhZaCjfLVbOkE+KeNo32HsRYDbf7rB5UaFxrCZDCF14GyyHBXgkZ9JivcrjWFjX2FPYLU0VVLQinCcqVjOJ1bpIYAGXXyZiCWXGA6TzwCsYsiiu8QlQg81pEWAihW0dGB4qOE2SU3mC59a3H2eZr7CpR84oI4RpEYiDci6w7aURZBCLRWLoBBZkCNwDXDQaHGzYfLlcDjg9Hig9G/q5ZvjTxen5m5vzPs5ZVz9RVn5ACo1UmGHuW5CsL5Y8OgfPB4f065AyFqSryeM+d2h/ZlEPTVEzcJfJxn/rVx2eIa14tMM0hgIDFSdLr3zU/lB860ERq3benThw0YzdcGO8+ZFG4zfrORgWF16t8BeZdzper/E28LKmbAMcwjWh2IV4afA66q6U60beK37j3Wdbvynp1LgIzQnGZQqkjrjuMXJvfHOyxrLTh53fLWDzA5Etcrn9v/B9Sikr5jFu9KnbrU80WY3YSHarGRh5U/vFsfWc7uodBu+J/45lQXltoPkSMQH/joO7gCp3RQagJIjur4IYiC7jMxzvlkU25j5FqNKje0qP/AUauNM97UzJ6YL/omadU77Fww8Jy3flcPdk64Qyt3Cj0SkfQeh/AZvTzHo=
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: eJzdWtly4zYW/RUUX2KntFm2e3GlMuOlO1E61e3xMpma2FUNkZCEmAIYALSsuPQ2XzKfNl8y915wJ711+il+cFEklrueey7I+yASNjQycVKr4CC4WEjLhIoSLZVjcJ1aETGnWZpE3AnGFRN30jqp5izUygoYZUSoTcRm2jDO5vJWKAZjOeNzI8QSR9AjxbSZcyU5bsUiMZMKlpaKuYUo1pqmMo5w8Wmsw5sB+6hhU7fgzguATzizco5TG/tLdctjiVJaJh1owU0shaHR3KVGDIJeoBNhSIBJBNpaYW5lKC5Jt4mK5K2MUh4f+4XPaF2YlHDDl8IJY4ODX+8bFrtU8vdUsMkJ0zNScvqbCB3Mkvg04W4B1wrmw6+wuvAElzbi91QaAcI4k4peYMOFWPLg4D5w6wSnWGdA6WCz6TU3Psz3YivpFiiALDSgtUkAkM2sSwkaQ77q9uj0w9znD0rQHvVVhTDiVlrv3+79awPKrWc8tk/tTcstBI+EKdf7Vz8Ll6Oj/uQLrdtrqFWuAyoFm2u/lLDuSEdrnA+B5GBLvORJEsuQYnr4m8Xp95WNtBKfZhS12ZZZeKI6jTvXG/jDnWyCClmcPh6NXrRdYjDBnPSza+FeUbtIESddjDeaCddwcjPTxV0CUoKIxYMtbuuIAshVh5JvLLOJCOUsE34bQQ2hRM1jwU6qQTlgFwthBFumFgAJMI9dfpz84/Id7eYMR2QEBNtqgFweWL1KHm6DMnd9pV1fqj6On3IrimAr4+PXQKLexWJn2Vo/covwYR3gUwBhULevjNqx1AsAbJccfBXAtbjjy4RM/Gp/7/XOeDwWb8LX4e50uhuOw7dvRzsta38i51i25GtUPuEWK8CUhzdsumZWLwU7PJ0UNcJS5unUIfZB/m2dftjugS9AZ7Q9QTcA/Jpxg5a8CiLDZ+4qACsNxADu1Hzvx4PzYDpbC8es06asErkFYa8IXBCvfTGix4YrK8F3J7h+fVWIDU0rLvgtCnFWeGoKcssZKIlugBLjYYSz87xm9OAHlZViErOgbRyhbeZCYTUR0YBSuAFsHa65689u+ksdiRju1mKu5QYIwXpUYryuFjJcFEG/gKCfCqi2VHNbIpyVQPeUKPnQTikKxaG+5U6ohP1jMoHMD4pFof3s8OU703G4G+2J/dmrwWDQEvRYJ+tcwDwRUZgFJTNdYVjhY6nCOI3KoCr4AUWVUBYuLSgIeQ6h5UACgaL50MAJ2si5VIDNhRHI/7XS+pTFS4TvtHmlAKwWmqyakR6Ctjoe4uY6cRNV2XWqdSy4esievh419oV7B2StUhPaOdGQWOBOSDfYhgw3YO8RwjqHAzpDhQBkB7TgkDhKsy3gf2g+yP2VgoxK0EU6LRTZJgN6lHt2SHiDdJqPVmIzKSBPKxw2Kx/+abjgao6OngGx64Nf+zMeAn5MCH+WiPKc6gmgHno9QxR2dITsUsSzAfsnAQMtZw9YqrxEwwSwEQNmCdBVRpcdFgILlS4R8/MZiPD+4nrjL2nGM8KowKmOolnGNYEqpgCqG8ekDoAaEIo8ZRoFFhOhEnPSlcF/I4o8myjwugS398BcN6gxDLyFZJlJPo19Ovn06UPd0mCwi6OTA8CT2LcAVIALDZhnEX+jSIAKpM2pETOowyr01S4zBDeGI52TTixtF6mo2yEr+sLnfkJLItb7LaBQgZdj++wy7afBcOAUpEW7KmdDnh3HLZE/ArHMbZwt9miG12efEA2yuYIQy3nSAnBhFSSssj9z63zfE71g0Y6WjwCp3CyGdbNmEYBpk3PKrL48wgEfrEGH7FsqtDL8toR2SgAW8oRSKzOVkZCQ1neGyFetb8nWWWghBfR0z+gV1gUQ19cEKOqpbyMgJne2WWjWidNzwxMobo0CMd5mPI0kspvBlbpSh1ZGgDVGL0mKq8CmIUSs1eYqAEHidKmQRJg2fUBjwlyMRmSoSCNexBa9Vhgt2NiS/NR2+EskDzgIrPIHmOUPEZ0rnsDuLrvrb2YM08kltBcQkl+fZb561cEyC1KB/U1NlWfvFT3Kn06zEgNV6CpbHvyBfI+CVoQLBZ1ADH7h0MXYqlsAIsElVxWhroIKajf3TTSUO0SkBs2h0oyAXrjmT5nxzd7bcWexO/2Qg0XWChPcrxC+i4wINrWweLYg98C1Np27VveSza183fjFNwaf2uo/wU6ygG/3xCEd7tCeuVFJ0VgA5Z/GXN0gzHWEPLAoSHLwbJjG/hSpngGDcj3sewANLDbcCknMFJkEhQTwHl+d2in1Jy2apwNsQvR6C1EMFPvp/NPHbbzgDLQHdnII7feabrNjrjTFMAhD9fQc41XgaMheNnl38Z6dvT9mb16/2R8w5DUIi8hqCxJADKkgAT7egb+FIoHOK/UoNol6DWNVf+cGACjMTVPBlS+i949dtwyH26D8XT7fOv/xsL+zjXKV8PZskcaj8V5/tNPf2b/YGR3sjg5Go3+3MyFfF2WgGMtxHmNswRPggoDraPwSYCbnn9gbAEV2eXHM6FQVxUMxeQoZY1CJo/Wk0U48dkLUax8oVZf6BN41L8Kfvf29HT4Wr8Tr/VdvR6PRzt4+n45GHXGbMTQic0DtoyUkIPBtU5BOKKYCyYAnCgUTwGDJC6UX7aGOtClywxCz+sL+8AAKKpB7Q2EdI2hUj2eIA6LAeEpcCIESAT2MhP/5svh9XvSGu+0A8vwYOIy0SFkYh7qLjYhnFEWj5AlXD1I4kWBLethItrr8ZWfwbCWqonb12C+TlW2tBIu0+saxG6VXeMySMfDaqFXZZnh6uh14ztg4ndy0DkmP61w045y5Q2dpHGNR9se1SGRwhT1/nllfaMoR2hOgBsVBf8fEnRcdhFbJGjQc2hxDYKO18fqksv11U9Mm/Spnl46E3lTMScrCe6DZpmP5DueXDj/qUDxj7M13HCWctEyz/8Iz4r+WaSawn8HDIHyXBLBC2zRs5Dva1Ei3pqP4w0R+EHh5jcfwR4IbYQ7BwHQHteZzfNNURHjOJXsBCLLQ+OYKJKMXUzgpGGbvsYblSczQZ8Uwa9j62c/7xhuoje8FbrtfbZ2Ipc70gnGpQWBeOJfYg+Ewgmd9nsiBhDZJuYHUw9tx0H5Dcw7KZHyraxnrH3esdF0azRMbcnluuvI4wN/odb+cOczC1rfqrc7ydELnGRjcYJQsZP2JIZ2P5Mzoc22dz8xvU7wgwFMFeQfYQ6ckn72M7DPbUv7tpcDTaRmTGRIeiu0eE4P5oLHsAcsmfrfWqUGL9EG47z8T56wGyX0wpV/vcxT/6ZeLtm6EglDlboCUZIf4JJ5fKZMZ6XJNCFZYkBKWahtNKAsxug7fhwWY2mfle6l3efLc52cVgT8WnekcH6BWUN4uwRqYd2mSaOP+Xji+8p7yh/JWPWLKwa1cLCaxrf/957/bSAU4O1+JSAJJJF4N3JaO/aiT90dV3uksSyGwi77Fppw4W2rpICWe9a2G0QLqFIOHECpu3asedYVYeOE2NC494upz6fDsFltJR5tZjWeFiY5876ljPQcUg0BQsIB/ra3ECjqZWxFj2CGOEdjxKUSOW9MiEKh6ybOX72BsyZF6kVtJPSPmqT9cs+hZzqgK+vMKknPJlQLd8PwKlFWWvJXnCoQmhOp4MGrZfLVaDTg9HmgzH2Zz7fDnyfG7j+fv+jhnUx7llH7ADIt0mGJHnOcggo33F1Lswe5gh6iLtg6kq8jjT6eaZ90Nn1fqzl/+24Us/5y4c8MkhkYO7UaOus8qwa/5Fw1B9XUEvYnOjFevB3DjoPlNAuDuAnyBi93f4wHUpYk3G7ztX6RTmZAWwynqbtWrPtk6y6r9Nnvye4VO/W4Q7ZufLRA4e3z5asK0v0t4RJ724C8U6YkPGB4RoTau3P0afxhCpS931YPftHTKk1dita5KksvZjK8NHollVeaLBXyg/e2y0yPfZ9R85kcf+936F7hgOaLFaMsZWGgT9+jYKnE7vcRaPc2+41gSeQ0MX2GSwv+D4Cqg00ZNBiDOQ/fvgxgKV8rnON4vu8na/DobuiE2lF1UPvyou6dJjLwu+L/yZUh9yncI5sBPvi+G+ycPTiioRJ7D/huT/wPys1rP
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: eJzdWdtyGzcS/RXUvERKkRRFSb6oUtmVJTthkrK1lpRUbeQqgzMgiWg4GAMzkhkV3/Il+2n7JXu6MXeOvNJmax/WD9ZwBmj05XT3AXAfRMqFVqeZNklwHFwutRMqiVKjk0zgOXcqEpkRVkn8XSoRy0y5TIQmcQpDrAqNjcTcWCETYexCJtpJkiZ0whPKkbNcx5FOFmIWm/BmFAwCkyrLQ6cRlnbK3upQ/aysnuuQ358srFIrTD71Mt7zYu+hCman0sqVypR1wfGv9x07rhL9KVdieibMnBWb/abCDLM0fU1ltsRzgvn4FTaFT0m0VZ9ybRW0ymyuBoELl2olg+P7IFunNMVlFpYEm80HGuxSkuDo+2Q8pj8QmUEkPco0jQtz9n5zpNx9Q15qyQmZ9rNbmjSWq7TPdBbTi5Y/8L5t/Ek3OupzCi2hYvVhRzoRqblOEF2OE0LdDtBXTrhUhVUsdgkFUjgMiJU4k5msojMSl0tllVjlAMZMYdTV2+nfrl7zapmVBCXgYSfCJCHLWVDuVjtIHkCDSN/qKJfxLoz5PExMNtTJkMbPpIPBcxk71YzLr4Emuyth7wtZ30tHkXUZUBogOG3/6mg7hoMA2F1JxCrAs/osVym7+NnR4fP9yWSiXoTPw4PZ7CCchC9fjve3vP2Og+PESq7J+FQ6SpmZDG/EbC2cWSlxcj6tksqJO50tTZ4RLIHPnfMfdweIBWwm32dLmVHarIW05MnrILJynl0H8NJIjfCmFXs/HsHDdLFWmXCZsWVMlSg9iLUihCBeAwoaQaLPViZOI3ZnJL8tFdgwLHEpb0mJ91WkZtBbz2EkhUHkKRuDERd6kcgst2qAH7cy1lE1SThYG0fkm4VKKONVNAo2cGMTQ9Pe0Hwezm+GKxOpGG9bmNsKAyDYRiXh9W6pw2UF+iVAP1MqEQt9q5ItFUqFH6FKObRXi8pwlJ4yCA3Yf0kn6PygWgztR8NX7s8m4UF0qI7mz0aj0ZaipyZdlwqWiUjKLDmZ+YlgRZ91EsZ5VIPKlbFmVKnE4dHBQOQ5oJVBA0WqeWjQBGP1Qicyrp3A8a+z/hEen1aDe31ef4Z/DXuV1KTeRaWtXQ9pcZNm06Sx6syYWMnkIX/6PtBZF++O2Vu1JbxyapBYCCfSDcuw40biDZWw3uGozugQqOyoFhKJkxixg3ZK7kPu3yXIqJRCZPLKkF12oK9yj4aEd0iv+1iSmGuFPG01fa4x/mu4lMmCAj1Hzx0irsO5DFE/plx/VlTlJfcTVD2KelFRxKtXQmdOxfOR+JkLA4tzxyJPvEZ7KWojAWaF0lWjy+1VCqskX1HNL2dQhfcPHzb+kWc8AkZVneppmjWuuahSCpC5cczmoKjl+FmkTKfBUiI0MKezGvw3qsqzaYKoa4R9AHfdkMUYeMt8R85in04+fYboWwYOu3x1dox6EntCxQ24skB4FvEXRgI6kLHnVs3Rh5PQd7vCEdJauSbmk6mV6yMVbT8UTV/53E9ZJNV6vwQaFaIcu0e3aT8Nw8Ep2IrtrlwMeTSOt1R+Cx5X+rgQ9sUMb88+YxrkSgOB5TJpUbioC3Ktcj9Jl12lEXWvJwjtoclckOrFYshFI/WCN/yPPFj0ly9wwAd70In4mhutDr+uSzsngAhlyqlVuMpqJCTlesFXnWfL6wJaRAE93bPmjvoC1PU9AU09Z30Ik/u7IrTrNDMLK1M0t06DmOwKmUea2M3oOrlOTpyOUGusWbEW14HLQyDWGXsdQJE4XyVEIuw2fSBnYi6hkRgq0YgnsUVvFaGFNh+sP9N9/0jkgQbBK7/DLb+r6CKRKVbPirf+ZcEwM73CNgiQ/O+zzGfPelhmRSqmZ5zwtSmPXiv6In86L1oMutB1IR7xIL7HoFXhMsFOIKaNIHYxrhkWlEiE5Lqh1HXQqNrddVODdkcVqUNzuDVTQa9C86fc+OLw5aS32Z3/WBYLU2CYyv0dle8qI4JNCxaPVuQeXGvTu2pzLd1dyveNX/zG4N22+f+GnRSAby9KlCikTuvXLJ3KhsYKlH8Wy+SGylwP5MGikOSIbJhT80GramfAqJZH+x5UA4dsQxhj3gTNNUMCvMd3p+2U+pMeLdMBizC93qEqBsN+uHj3dpcepID1YCcn2H6v+bU4lYlhDEMZ7qcXhFdFo5G9Yvr68o14/+ZUvHj+4mgkiNdQWSRWW5EAZkgVCfB4B38LVYqdV+6r2DQadJzV/F06AKWwdE2jrvxH9P5Lz1uOo2VI/76Y71x8fzLc3yW96vL2aJUm48nhcLw/3D+63B8fH4yPx+O/b2dCKZd0YIyVdZ4wtpQpuCDqOjm/LjDTi3fiBYqiuLo8pXCDoEEMqSlzZIwlI16tp53txHY2FJwbFXTQPchpi3qH6Non1Z/Do8N9OVHP1POjZy/H4/H+4ZGcjcc9uC0YGpM5UPtohQQE37YV6UQzVUQGPFGomACBpWyUXrWHdqRdlTuOmLcF+8MDNFSQe9s84auPZ5gDksLg8aJSgjQCPYyU//k0/D4OveHBNoA8PwaH0Y4oi5Dou7QR8Yyi2ih5wjVACqcavuSPnWRr61/vDB5tRFPVvj3203QVO3dKRCb5KhM3ibmjY5aCgbdG3dXbDE9PdwPPGds8kV91t/xbXLRzNLFD/IkOijjlJsDyeBfD4QV1S1sAH/p5HsfUvpdKRnz6ek9rHfqTz/aSM0lNIAWJqE5reybuP+nItEnrsDUx9hQpQHGh57PG8h+6PukStXp2HXLsYtWCtaziDMs2PeJ7YFJD41WP4QW37x5U14VnyzVHTzxN/v9yzRTrWTo2opsBFCBepuMjv/fNrc7WfAtwkuofFT2CR94Hr5S0yp7AwfyGrJYLui4ImrcM5I3Pw9Zh9zC0eRRXxTXYHpBqPTR2iITyZz0YxSc8PUNdqBJptcGQ/dGkZwDKf8gbl+DqdHg6PJ+eDk+G4/EBuy2jFZC5bN4N2fZFZQcBH1SQ0uSB/glbytezvBEPT62MqaeQUQ9PKI2rx3eMpLAABUtDl0ALxVik+5njYK+4Etq7bURrr9hSD30Z27vvXN9s/G7ttv9e6EytTIEnjMstRXeZZak73tuL8G0oUz3S2Mgm2UibvVtvWVvGBUBUMOI+Mc5/7pH0oQarp56caiVk6wMb/6K4q/Jor2+rTopy4aG7tfc/n/KJExUVOKXwmT/TZf+X3PVjS85H4ZeprnDo3Ed/Rs3nc6yPXkfxUeyg4SgWQPc6MbshlaHaHQg1Wow6Yo9FMfGbtckteWQI5b79yLuCZnLeBzP+9abssz/8crltG3cf8JAb0MbimoXV85IKnWlD01JCVB7kQsnsgyfUVIlCF2z4SHpuyoqLPs2VcAU7qZLlaWps9tcqpHVI9Hf1qzYW6sFb1a2aJHb++cc/domGSXFxpyINgs59GfsKPnLlU5RmCogiL2CxuaUDEebLueNDrHg+dAajFTiCwEeAIFsPmseMIZEevEamD3iftNAZnZvTNj7jxZyhc9rURH7fb2KzQF9AiBMIoJhLkag77CJvVUyAos7A7UPOgIlszUIAQbPye8fQoPZrSbSXA8bmWbXI/cGmo5hJwbzCnxWxniuZJLCNzg5hbOK4F5VZANABhJPReMvnd3d3I8mfR8Yu9oq5bu+n6enrtxevhzRnUx+j1XGg3IlMmBMVKrOLyoiPF21vRgejfaaNxmXQrqEP3Un3X413Ydxo5//b2/YC6xlayl4aY1tLlrDr7ouC+2t5B+8NrxvkIGgXXbw47t6ao7gt4RaScn9PPPLKxpsNvf6UK8stmVqAZQz6ygzV8Rz1n180/bTzviA2u+LBi/1e88qKmqybjXFQtKquCRs6fCqqRd1tqeykWWP+FgdrdbDvXlPlkkVZq0v6DZf04oGk9+rWre5eBfqf+lDvlG8Ityiy31bD/ZcHJ1T10I8mT30Ak/oXkoXPxw==
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: eJztW+tu20iyfpUG/8RZSPIlcTIjLBbrxEnGWU/iYzsT7IyDSYtsST2mSC6btKw19G+f5DzaeZLzVXXzTtty4gUOFmcwmJHJ7qrquld18cYLlPFTnWQ6jryxdz7XRqgoSGIdZQK/c6MCkcUi1CYTMgxFIDMp5CxVaqGizAh5JXUoJ6ES0zgVMhJxOpORNpIgikBNdQQIOhLZXAk/jgx2iUmuw0BHMzEJY/9yJM7xLlUmDwlgqkQiZzqSmQpG3sCLE5UytKMAFBqVXmlf/aJSPdU+Pz8oqDkGkdiQyFQuVKZS441/u2md8EO+mKhUxFMg9OM0MHQ6c6kTpt8hxtKROBCRmuH3lcKZRB6lSgZ80CsZ5jguuGHERPqXBOHrzleiVROKf+QqXeGPCFTgz3g6NYroStU/cp0qnAJ7jRp4xp+rhfTGN162SmgpmK5mKsVaME6CHd54Z+AtdKQX+QK/1+vBTQE21AudtVE2z/qzvKaNIuo7c6qyPI0EmEunVqNvJXDXUtXEfAA9mPyh/EwsdTYXR4dAd6WNFWI/mxoL7qfEZCkUyFuvv9Bqk5BmGXq/t7ND/4OqZVAJ+imTJHSqsv2HIfpuavCSlBQs03Y3qXepT/xEZ2phaojtuUBjprOQHhzWt3RkAE6U1kL6n0kdGTYGkyi/1GESjhQGR4KCJXmaxEZhlcQe2NSkNB22xpGAcjbQsqlGUNXUyBBWGPRtE5OV+NNCRqs/wR4DfaWDHMwFljTOZ3Ogb4A8ZVUZXUQ40vUwirOhjobEnok0qpRLJajfPEc2WaD9dVjjxIAlksZhqNJPadj4+wNpAHbFEBNpRCiX0zx8JY02+AumPI+Dj9NPDFr6ZJH4AXOdqSwji6Qteqr8lY/f0IemSHXQVRvevpBQDw+/1bVcJCzLF/vPX+7u7e2pH/yX/rPJ5Jm/5//w/Me9jli99cAjbmurTptB3x3tjHY6oMj5OVCkBRm54KZuQHTLufZJRDBghZ0kV8JhiI6KkUe9R22igy0yFtYNt68JhcRzL5hPp8cEh8NBtVVsLeSK9C6GcyKt01MRxXaVjq7i8EoFT5vYWPj3oqNV34PP6da47ahO+DlsJwAwy2QWQNO6zJxCH9DMYkgKAQ0W+HmuIuEjKGQUyGQrMA6YwyFiGOKmRV6YZBFSpxowaZVzpTauDASbbyOKygAhgLcHUItA0W5/LqOZEjorYmsTvwjVlQqt9d7muE4Ke9vMvCNrpTm049Ft7OXLnd1eG4tu0Y5+0IeOk8yL0p30axLxzC15PFv+pW7HBXyxpa0bn0Jn46V1/moBlMLCZg3N+62uH/s8yxIz3t52T0Z+vNhOUn0l/dXwlnOfKACKSDXIdBFYatoOUlZNH6TESUNpKfkZwA7iPAxgYRk9k3Qaq8tOG8k6RKYhMhzojzzVJtB+9iC+vvnUofx9HdCasocgB5TVGdQ5TjcH/ZOSYTb3kWB2naIDCbkwTGAhHTpVlENgCZin4+BQrkxvMtSL79mL/TYa8iqUeFmglHsBKhlwQJCBdKbiWSoTSOZU0Wm+n3nvSoiUYZcggcvgoEj8jmMbZb4Ly5mFJcICGOBDs9LgRKbZio59NpcMtMIyieNQyeg2NFkKZ9gtT9IA6SpgWhs3Dup67SR2kIH2SZ6puqBkmkoyiDKVg+Z+nHJx0PaNPfKSJcgif2uGZ0MWA7L9LFzBqCQnYz6FJ99VMA/yr3UKHj+X2e/xs81TIll/uOP90KW96WlL8AOus5ADZzLylbhgRBcelVgXHlTogt1+A9CmRLzNEVCjGtIqy+2eufqrQyIbh4qMRqaps9XmKuuE2jKNClKZwDRQQYvULE5Xmx8U3ghlTM+pXjtQ/YiMHycPkCm5/K6hEwxRqC3Lso2Iy8G2XTXVuOaJ7rTTu62Tyn1b1Nag3WVtTSKQuwVIGPpz5lsiyLPDz7s/f/r86+rV5cn+8bvn6fnfT38aPxu/Ph7/sDMuauKOWICJXD5KM26IaFY7a2e2EH0EIvbGr+ls7JWU+DgVp2oGBtnWyfhFb7pyxsiZEv7nS9v0HsUDXnA4KKrDjVP9YsO6t568F0zLwmvQ6uXlxlzvah9DERMCU7qQMv0elr2ubaTiMxn+Hk9CPbP5/LatYMAv/IRjwFvKJUiP8SDJsdL/PZPm0m6GuoAgVa4huiLqB/3mOSRUALeQFAW2ZMNpIuEKvURiN3eQkC7US+9v59TPDIV4hNIHnInIT2+z3/jdxHmKMOD+yqkB8rtr8VXHpA02vLv1nvuruZ61N9ESOvs95J7bYgo6GJU5shKHJ0cH8DRJnLJ2z1REXUm4QDkFw6h5ggWeo+AsXyxkutqokCZ0n05DAeeEWEW1ZA0dtUQdVoP024IVKvMbvaErboaClskKxeNKFDJUNlcif0eeRs8imeUp8+Z6OL0cLuJAheQGyjcdB1G84f5UDjkiFScabQ6Gh81CeavcYISrzFEaNFrAcMi0b4GTaUhAlGSZp3dWq3UiN+xHyVUYcwwztb1Xtc6x1czWw5NyW8/Tn6SZt94QYSp4tWJaF2A7NOvxM7f9vsztIzOpZHUiDfUWuCcNVTAxHOnByVHZ0DfcjY3zjPr0OhBbJ397OkBIAjOt3kGlIKMV9+Al8rEghXZfeAOhR2qEJ5U6ZM7LUym4UpmgYqISciEW28qIEBXUNWKR4feppIRoxH7dsXpjztyMRqN1rwkhrCK8OoAleYZlM2BnjILCZ4M1OMn7s48fUOyliMlFlwVKCSMKAyNuegQ/FkA9ELeoRM9bq1s9Lw4oSsMt97wqVKnn1fulQf0aqHQgSi1zy+whP1vRWpU4VVN4ACTYbom1pnPwuPGguWw9EmeOIw02Uek9Ekc2xJWm1PSCEwWBkbxXKPugS8T7fpXYIp2YM3RWv4z6aLSiRVLRbKg196ZpvLB9FSdm5CTcRrNo2BMvZRqYUcffbaZeavV+Pnnn64/6/dtf35ye/9fZ+x/BmLvdYkEMzjS3bT8LvEgKKo5VJ3Lpk3XZCpJDCOkqDxVFvTrgOlZtP7Z5BR/s7e/v/lgeY29nr5scHoilCsPhZRQvke8xwMpX2MBo84PinnAkfoHuBLaPacbi/NUhXe3h7ULP5twyUtcJxI9j87WQyROKbPizfhgH1fC1ILjmnJsUfA8GIzeKeVvtdhtEpHxlDCLkqM2gk8dxNEcUWOFn4NAq1TeVzbRaaIFt9ziFZllXhmh9Y0vnh6wP15y2cVs5quC71EAXFZdh67zlpBynNj6t3J3s+c+C52p/+qJP33vP7aerJCubS6T9xbntBSldOKnSA3MEqV5iZZ98WocpXOV3ZHMHTd2SDmLhlgiKu3tDMkV5ihUJCF7ImRrUrBdZV5u+MvRvTF+gg/GlWo3/+eLny2kfq18pX+YcORGhqWiEl0ifUOS0ANlAYBHtjit7HuuVJQzBtmXZBbtgWNtvwzxvY0PCKUAzXHwzRZMtEZesGNiuMUfLwqmVhSElHRXl3CEI4/iStDdPSo+2KhJdW4gI8KTuL8sUs4eoKI6GmxDmN+jCPloC91F1hcBWahchs05cR8VdlQ8EymIdChkEyEsNktmh4yX0JJIJzpxZtk4Aja/Tm57+kTjsXF9m85uZSpOU5jI67S0cpM5H6q9ZQRAiHE+CwkuE2TKAQsNIqY4O4V0MuayOx7SqffCACvmubtvpwdtz8fbozfHhWJy52GdvwVMV2h7CXCc4a7ZULh2oVxs1xkaBO7tFVavQijgMifvwVsbFHvwLHOpKgnGkjK9dXW7vt7HqJAYHyrkOxK2L2lEuPNSmSIQV1deZuvA6jKqC8nc4qZD9K8+aOF3qhvdmPkgOnrnRFprTnxnBQgL3+aweoNxQxtbp29cv93f3+eKpKlo2PgDyhefDnd3h7v757s742c54Z+fXblZewC0swFHm5ymCHbWKasaqTfQkY5Mv786cOE0sdPbEVhoETaVDVFbxtEjxbst8v7NtewQVoE6asXbeDtRLhN9QTeEAQhldFtGkJxXg3bTa0kpUVznAQ5qxdjrmzia77SUKLuv7yXZlII2Q/FJqeymbog1fILvwaq2mGgVVZv2lPE4f37+hzH3xoqfMPRBmtUCSl/IlVlg00bjOLdOrwnBqGVaL9yPxWXFpW2ngH7nJLL/Cws/YtCvmlLzyO1vSNjKeEofKZXAililiy/oh15CR5biT8/LO59jxqwEF99qkgLslRn7xdGRvstyQy8Ya3PUonekgC5I9RqSWfaM+ppwZoqEGq6r1IZvHosZiK2IbeVbKJpc8TuH4pG2nIkjlMhpQpquhtNxCYEm7vkOZ7tvRwzzQIFSHOrP5vx8vEqgKSCcH4W7m72+0Nzpjd892fT46Gdsg45xY02dw77wSQsHlIqhTHwS6m1aFLQCJimqRkBLFuWkoE9s52XyDNNtir4ag7u06MumvrR2I42IfkhxufFo0DQwj0V5mRzWLaZaFjOgCWLtKQSzj9HIaxkvDKteeHDDWImkMAnEZZr2APoFOY0VpdbWff3ampfBK3KHyrLBJkWwTGBs/UeJwZjvDd9wxbXYFnNssxEJrzuYQvd3xm4de+rqxA4iwuEDvNBAfdiF7Z5wI7j6Tvf982GxFz/ULTf4aN1BRYG6jCR88fHArogLUbajceMwh8qZJLNPglub8A7E6qGCpAyvyNOwnwV6vQaTRQaLP6vdn9191ntfLGjdD+pEgnRy1ZgWD2M/ZXCyASVFnYeWTarQbNQG7OKoNqA1RjFjbzhnpxxlftHy35bj7nf8Mk+k5zP/byr/NVigRaqgeXxgU8/l3TWSfVKs6l/425GFFXTPqY+2Ni3sXIGlA3rUG6kfdJQrjTIZHrYGF2+Cd0+LaOD6bUvUJRR323n4BnGj9FuBENH2gwHVfJIrvBar5NM4Y6OH9sD+0SC6+GmhwYwcA59KcuLSlN2G8rcjSU9u/ekLtqzLxaaNgb2CxfFDX2bdjiLC7A50mztZ1tXOKZYfLesYiqq9gtko2H519FHsv91/sPOVvZijHyX3KU6d5GJL7nHOzgLhDYJ/brxWa0CeScskk54LYfsrSs3H3QZ851D0oks44fQ3/T6en3/XBii/dK9imCVW7+/Sm5CZOtu4B3+NGKtfxqufg63UP/z9Frj30TxV0WLP/wC9A/rNYU/TqObWDmTKaFo9s0MpTnm5DIEdC8jdFP7/Q7NYrhcQ+PQCD+QmdWs4o4nv1r66IGwt37+TNlP3wirZ42y6p3K63prYpgg4rk+EITgT2faR1qBaxo99zk9HlyHOAd0OZ6JGeoYLKRjrevtrzup8gnWUUBWa3gTH2dQ+kLxVzeD7KirZgUZUO2QfuYybLXa/8munAqWcRhVoNDaRt1KklJaZOue8+OTuv349QVPzagPNVWDRiQW2LCVeIU31dXKd9tTSKr2ILeZRtG6PK1La1kUhfPR0INZqNWmDHwm388woJDnFkCOL+8pVzwboy3HgT/uttEffffz7vno29nWs4u4kEJs9CcjRTx6xBhCg5yIbJPp03eKXRkei8NQ+AT+PCwt3tEPfryXLspeBfS5FWItHvqkdNXagWd6yp3CS2/udf//3UXq+cLVWgzdwmheraXcW0m7FlbWUne1Q6EkcZ1cuU6IXToaG7G4U62F2XZKuiw8tfGfrl0CA38AM9oxkusZQh6lx7MRjTbWsSo/5W/jyKw3imqduvIgCw/Slq9fCXIBy6yTNwqm+7JAwEKhgv7DcsXENrHstlgbnry1nuOvR8xy44jhXdlpCuZ6MIZ6NEHIeN7KRYYQVQOijhHo8eNnm+XC5Hkl+PkPptu71m+/jo9ZsPZ2+GtGddpXSVHMh2iiKnsK7y6w3uTI+ejXbtNz8mA3U1eo5v+Yq1rcS14PF/8pNYZxAZspjtJEQ1WPuAxDrh37xqiq6ulJ6t7uqOGP5uDk7RnpsbymOQ7a/X9Nh+ocnuGdTjQEF/s7zOrn/v97W9B78kv1x9ZsvbPf586CGEP/Rj2TtIKVLtb6Tkno9n70DcWFdh/0J/pNp2cSnGF+GKRGt3ktdO6jR3UqZ1Pd6/e0OOX7qoUEXES46I7ketRSCjVQ12OzhaEui/tdHx5pY/k9kjRv2lXG7f3LqhDCd2NXGJSsr/BQ727so=
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: eJzdWdtuI8cR/ZXGvEQCyKFE7dqxYDjRSmub8UZRdiXnYS1AzZkm2dZwetzdI4kR+JYvyaflS3Kqeq68bLQLBAjih/Vopqq6rqeqms9RqlxideG1yaPT6HqhnVB5Whide4Hn0qlUeCMy7byQWSYSkzuFb1YlxqZOyAepMznNlJgZK2QujJ3LXDtJEkWqZjqHBJ0Lv1AN87TUWarzuZhmJrmPxTW+WeXKzEOgVaKQc51Lr9I4GkSmUJalTVJo6JR90In6WVk90wm/Pw9S37NG76AomApp5VJ5ZV10+vF5w8rLcjlVVphZYwUsdPe6YBuqw0EaizORqzmeHxTsEmVulUzZ2AeZlTAZHnFiKpN7knB3dEf6ajrit1LZFf7IoQX+NLOZU6SXVb+V2ipYAl6nBpFLFmopo9PnyK8KIoXj1VxZ0MJ5Ei6JTo8G0VLnelku8bxeD55rsZlear95ZN/WP8snYhT5Lput8qXNBRxMVqv4SxU8hla3xOsKioUj6vHREf0PIfcIDj3KosiqkI1+daTdc0d6YSnQXgfupBtTfqO9WrqOGmb6q0rIeK99Ri96abDlh7ONzBXqqYC+ULb5cCBdP2GR//1M/Z0TrlBJk3mH5EQpHAiQExfSy7O5VWoJaZzUSOVlicKZKlDdXE7+evOWT/NWUn2hQA5SMAlZc0G5B+0geQANUv2g01JmhzDmaZgbP9T5kOin0qkmPm3APkaa7G6Eva9k/SjdAu+dR0VFCFPf0+BpnQrNYAuIUQhLiahFeFZPclmwi796/err4/F4rH6ffJ2cTKcnyTj55puj4y1v/4WD48RSrsj4QjrCES6U6Uo4s1Ti7GrSII0Tj9ovTOkJQCYX4uDqp8MBYgGbyfd+IT3hx4rBQYpfotTKmf8lgpdiFeNNL/aBHsEDu1gpL5w3tgWh2oM4K0UIshVSgdCNPluZO43YXZD8vlTkhmGJC/lASrxvIjWF3noGIykMoizYGFB80HPgSGnVAH8AMHTaMAkHa7OUfDNXOeEbYd0abuzm0GRnaJ6Gs/vh0qQqw9tezm2FgXC1R0H5+rjQyaJJ+gWSfqpULuYAuXxLhVrhF6hSk+7UojEcAFQHoZP2n9IJOu9Vi1P7xekrj6fj5CR9pV7PvorjeEvRc1OsagXrQiRlFqFD0ROlFX3WeZKVaZtUro41Z5XKHR7Ry+aoc6SWhwaKVAupQQzGamozWesEjn9b9S/w+KQh3unz9jP8a9irpCY1dIK2Ph7S4abwk7xz6tSYTMl8nz+9LdXWuXh3yt5qLeGTC4PCQjhRbjiGHReL7wnCdpIDndErgOxAC4nCyY04QAcm96H2H3NUVEEhMmVjyCE7MKDci1MiOGSn+1iSmGmFOu1MQlX7CF+ThcznFOgZRo0h4jqcyQT4MWH8WRLKS+4nQD2KeoUo4s0bob1T2SwWPzMwsDh3ihEjaDQqgI2UMEtAV5tdbtQorHIaBz5GNQchfHi4XYdH5nhBGjU4taNptnnNoEolQOZiECRzeApydclsNFgqhE7Oad8m/71q6mySI+oaYR/AXfdkMQgfeLrjQYukhPIZom8ZOOz6zcUp8CQLEyY34MYCEeaJP3AmoAMZe2XVDH04T1R3eJDWSpqV9g4VfT9UTV+F2i9YJGF9OAKNClHO3IvbdGADOWYKtmK7K1ckL87jLZUvMSHWPq6EfbLC+9wXPAa52kDkcl20NAfDRsYq9046f1Ok1L0+Q+hGntDMzYDUHpZBLhppELzm/wb90K1pxK/n9E9NhVct1aaPkxJBzD0o1J7xttccAjUPytU03Y3AMWloPHB7I6X2ybsm4s5YzqnYrlNd2ePXtXDS9UuEk9K0qBCGoWjqvaE54QQHhJf/Wfblhsr19tDzxhEEovivKox+QXZQt0oIBGmW8jQ7Y9ruoPzmEVxX4ZRL9eS//IQc3FvSqbf10q5KLH61OTX0N2JalQkbygSY42ZllhHSLLA58jb6TBJeheWoL2gqqcCKkrSpttcdjMeftVV1YQeYZew5QJ8MpeeLzvG3m5ZuVkvLvStFGsfBsvUO8TuArAWvNzsMr4q+76GbXJbYE6z+O/e7vmtef+bC+f/lmgnOszRP0gUJKpKP2fBRaIql1X7FtyJnhf5J0eMt3Sm8Udiu7BkczG/Iajmn65Ooe9lC3nga9rbgYWLLNGvGiWiboNB6aOwQZRKGwGpQ3EHpEpVLqw0oTuLjgTiOxzuoMIsl3Fyjm/Ph+fBqcj48Gx4dnbDrPJ2CmmQT78m+Tyo8iHiKIcXJC7sZtgxoudiQ/ZyNQS1HY9h+rtrAlmnDUAoPsmFh6E5srsKVF0UuGlU3ZKOHTtRGVc8dViBFwyLnya7rsQu1NFUaga60FNSF94U7HY1SfBvKQsd6jl3Zx9qMHoIhfRkfPPXd+T4xLnzeIem2zdEPVKqhwupMbQe48KK6+gpJ3l63nVUoUff9jan2asITKGEJfFK5KOx44V6vmpvuenLuRDimudKhOVA/Aep5rr0LOoo7cYD5SLEAuufJ2A2FTNThQKh4Hm+IPRUV47crU1ryyBDKfXfH20y3Jp+jKf/1fT0A/ulv19u2cdPBVHyPxbm6dmH1gqRKZ5rjekqIxoOMj9xFmSFqsI9CF615RZ2ZGmix7DAAYtOh8LqyKIz1f2xC2oZE/9C+6udCS7wFag2TOPjXP/55SKMhhv1HlWps4nyFoJ7CCsZ7QjfjRVUGsNhgw1CWl7LS8VCbzYbOgFphbxD4iCTwq0F37UjQGOg1hgy6vUmxrNNE9YjNR3k+zBna2wqD9UQli9xkZo52gBDnEEAxp8niUWQKOy8PSwTQfJc9RU74FQtBChoEk8gTA8jXEotKCBibZ9W8DIuOo5hJweME2FKoQ3ouZZ7DNtolYGzuuAXVVYCkQxKO46Mtnz8+PsaSP8fGzkcVrxu9m5y/vfzwdkg863aIbuNAtZOapKQLi7q6CEZCvMZH41cx4I3Hc+M8tOvo827PbwibSdzp4f+TP0hUBeHRakZFhv2ezGX/Plcg/LH+mSJ4p22eg2gTiIF3C3iKeJ6faUC/sdl6Ta/DfT7DM7SHQe2d/F53/Xd/2dhpeGhgzQ8cvWb6csU/92eKT6hSLzetJrf0h+XCDsNO3TDaCYFws+hybc2OvY77w1uCXlnhctuT7rknVQ8kvf6UrzqyN9tTUIH+JaftZPmWCg9d4ruGPHzZy9AAeqAmB91iAvw3e+q+BA==
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: eJztW+ty2zYWfhUMf7UdSZbtJE29aWZdO23VJnWmdprdth4LIiEJNUmwBGhZ9ejfPsk+2j7JnnMAkKBExU7a7o+tutOuSOJy7pcP8F2UiKIUMTciiY6mPNWiB690XMrCSJVHR9HFXGom8qRQMjcsLgWM1YyzhZjMlboesIu58A9Mw0DNDLwRNyI3+JMbtlQV09UEV50IZlQP/mU8Z+LWiDLnKRtdML3URmR2tYIvU8UT9ub7lyyrtGHa8NKwhTRzNp4bUxzt7Y2ZKu2DxqcerJcwaex42KXK5a+VYFMYheSocsZzqTkyNWDnATHASiZzmVUZU1O2bwlnZlmIwc/5zznSo0V5I2PhuBM8nrtRXCMbX19cvGavz84vcDXTpt8yNFHJks1VCrMfs6kU8OOIjRORyhtRLkenQP7YidA+GJkJYDor6AFoGRN/44QbPrZrute0mlt7HzlAAmphJwE72soIv9t1WnNrnTE1+UXEZsC+BNEBd2ej00c/nNhvPT/TzhmHUh0lpASmyHBAqWMN203U7Vk5c9/s5mBCCawlYYhTDlggiNbQMgysUZXJpuzlLHey93KzBkH8/KM/+qrkuemfwzBuqhIkMxc8EaUV1g1PwRjAkMfm82e1cJ/3YNXPn83F7XOgbzEXJSxlH3EsrpyqhShjrgUsdwvrxTIDur9+dXzSP//6+ODxExT5OFhy8OwXrfK+MwFYqCZSC+DcsGuxtDR5zni64EvtGMSB35yffedtCMSWaoW05VZ4KjdeocQPL4pUxiS6vdv+YrHog8ln/apMRR6rRCRgLqPc+iHy0SOvAkbgm5Wd22mMvpI5m5gIeBDkuPFcxNeWAS/bDeVk/Fqg+dWa4QacuTDkfo2/EN8l0Z2D31VGZUB4DCo35bJeFIyhUDlIHARqKs2IUjJsmKcKUVo7QeYPhkNQXK4M/tx3jlHPbwy7ET2TOYtTwcHwIPrAnlEvqtccQQyMQMJTOTuhOPfW+iSMKQVEE22+AEeOju4ipwb8GSoAVY/vNAgt4/irKHF1I4XGJ+fjNC1Nz6bR0U93tLQsMf7+FDldvClT2NNtcgGqhqfGp19QaMVXxNa3Yhld9iK0CCDfei98NNKk+MJycla+KZIWR+tRvgniVgKVkzPENBv0yVsVq2idtgmDYYC5gEIkOjqGBfL4dgSwEayJbExObWYQNjBA8B+BYZMprYdsNi1VZs3Vvv7Nxxzv5sBRW9aBKOHJSUebUuazTu4xip8jjxTO0UnIZyAcCbBpS5KXkFs7jC0PzFMkhIfkKKARAk5WkA79dPdmEKtsDwnRe3KGYS9ata3lQQy3QolLHBsMYhJ4QIzpbQQu9E8M6uhwHEJHPktFGGFynkF2qoMP8ZtXGTrBhkf1onspiC5XHS7SyGHDLTrcaVNEQfK01hDKyFtGD1k8ZLNSVYUesON2OeEEe8h4WWKYJ91jZHpH3dHyrVJMKy2o0GiGWGoojpKEKVVJWBmWklB2ETHtdRIl7PBSZOoGnisrUmfAetODYoyiuXnFcz4TGfx624QvJ1ZiakN0J3YipAU/M5QkkaXrClHFcVXaBAcsyjyRNzKpIMnOyO3A/rwEHD09fMf1tcZoBBlHGEhqiVrkZHbwzUYolIksGdYryJqEhKTvd4zztcopMEtayUU/UBwUMFg091rvY57HIk3pvSN3AJEeiojwTQJOvvES0+GVuC1kufSLWuY2N/PMdnyxM0Iy2jOaL5cr8JhEzqTh6VsgRzxYvad2ElvQrLZqX1D6D2tGRrqj5E1W+TcXxguRy2TwydiZH/iHrUdUni79O7LyugYdoXLPYB4+vQZTMWLmklQuRKJdXex4stQFG0xEqvKZr9HBA0XJTkenJyrLoAJVRsUqrYsQT19TrOJKzmSnCrVHy0itK1hHS1ujBLSK23jO85nzZr/enPa9d1k7jJZtzw9L5cEng5vD9dlIQS0iTwM0G66AucLZmJr9s4tiPj2H61/x+Bo/QLYRTQIGBUsI4Za4Xscs2D0B13rwgiGvVI/9flfdVJ6aTkVJzNuCr/Ozl0XnkObnFSn93lHE7P2DYlGY+8dZx+4ehuSgW8OgXG4ZY9S1yDcI37TGYEunxweOXuP2nrHrTLfMOjRVsPB7RnmlbR+5aYIPHOskgKNttIRQ+oqX18IUKY/Fg+MlTINcWM97WDI0Qe72qEud3BCAQWoYpJI4VRqaMsZnpbDJ1rXQf1jWC2gf4PNVs+tVveuV3RUlZTOL5hPMM83mE6Wg88o3dn+L7I5NWQlXR/oKKyhZSMdOcK7LlCi9M4c2DNipmPIqNVQVjAnJoqIysa8duLUKm6b7xdK0jZDEEmqFVFZURmxHHUJowLYmTRPs22PfpxJTpU2Q0tDydbMN5cAc3SWWZumLyLoqP1UkFpgIdmD7DxiiC1CQpgR61DIf62+0x6SiIjZ3WBa04XVXX3dSKKRrWZzr9AeK9bbu/hBFIgHAYK1Hyh1L+nTx8pzFWGtObRHaZtFCZ++r3NXq8gP6WmB41Wt14b5N3+iqrWU/bINBFC6KQoG5BS+h7zGi1NT6t5dq2H1jG0NJAZOSrQf2bEPd7o2xKde+jYQyy0XGASN9BC02fLM67rXMo6wc8BSAKwHadGv87rZn66Kh5xsSKAhmXObatUq2QqTp8LmTeqwS0DbCeRn8bE1eB3BfCn5jndD5mKqMl8PaAhtgFSg90aE0bMm58MKqPQ/Nknp5DrUjlKclOZJGI4RkGoi3Y0bOjl+PMHK0Rd2gG52yqGsiN9mC2g5cCSiGAKJQbW6fPg6NgVvXbHcqaCId/oqDXRHcSYSFL16/uWB7Nwd71qb3eALN6h4vJMzeu4P/hwA6SlZ7boU+rDBmqD+gjyQOwRGyilUBwjQOT22OG8iaalwvBGvrrAfWJ3PqA5SLYRDCehTDcPkWuLSAzVuI0kQBG3ZZ3dhAF8PUkotbaJ97HprxnQKsVm6aq8dvgJlULaGcYMc5q/LrHLqswGkJDm/7cLdyWt28X9SW1u0VaJylzgoF8j9WrgTbt6gEW0BQ1noxPk25TK1qCd96NBxSfYBxxwoJnlAj8NwWbSuMuROiBt9sJ9BVCFo9efr0M7HPH8WPJwfTw+FwuM8Pk0/3hxFGaQ/SUnFyMBz+maCqpELT8fJ+CGtdxYR1Q3d6RGjJQZvvgmO3AbDHW9JUZ/jrOj6wZ1PUfluErYbMiYQeNoPoQW1QdhP1kcn9hdHW/OQPBaO2IfD96UF8mDwSj6dP+KeTp/FnyVDso7lYtXz4hptuBD6o27RgPRMa9Ifv1uW8bW34A1CQu9MC5hZMzfWJaYcX+3Wt72d0VHK8ATTatYLDVQf2YdTRMeiQWH0f3PthKPefC0WfPACG3oHDO3B4Bw7vwOEdOLwDh3fg8A4c3oHDO3C4Lllz1caFl7bi/yCYt67jvHBtflLYQ8dVyt+F/HowadoF9nb0B+5OWngfCZ9sC9dwafvkHtOKEhEUqkRCfcuJa8I8wm94xewPRnFbReL7wbhISdMa39+TXJwwHL7N0JPQCqi8Hv8T/um/etU/Pb2Yz4+y7EjrH+11Nm621Lk29YWKIGzH325qtTwHw4Mn/eHT/vCzi/3h0f7+0f7Bj9F9YHPLksAsHPENOZjVhLEdl7035a83+btS9Bzcl7IXR38fXH32LbDmUDHQBQ549J7oS7i1KEtVnkCPhQLD36fBbh0oSLuHaGY3VkGFG6FRtQKAwFXH8h2W1OjsC7yBlBeVYTXkjuLYFAgOrAHzlm5qR6WdEVvEQJ2DfagaY4GvGeRN2L2HA9ZMvzG3h1xgpg28+TS3RhElDdckoFL3aqwzvMpch0IUDLVCcrrWGxISsX6LlJyap5LSwrp17P+FreNNjti+KuVvVJC0RfP4L+04o9xd3ncOQ9usycjm4aqUZkmo7DGdG8DPy1XvLvqCDlWOQcD0BrnmMzwYq0FSeAUUzBXeyy2UJkFwHB4FRxOLGlG1lHQdrZ2KTDlCYVyF2FiNZCXwrc8LObAA1kCqCKlbqxGANBDVtjW0/by+zGXD/zmagdWel0JTGdoXW+D4Y2eBHmZew439SVFzBlWDkvXJMGWS1jp1ueLPMqC2ncpbyK42SFka2Zh9BLHBFj2m5DIlGeA588c9JgazwdqyR8xNfIYnJygOPJt6PqYiINT3XWSP1L6kJA18fPP2YpO34LgNzFFrT55dydGMJUCLCFZLkHyPah2aENV+hXqjPIpe+n1zt/uF94PWsUIIqd4PgK7hn12IZRcWuR1Q24YuXW6DaO7pcS+3NysfVNKH9bw/IGqq7ybIdJaj7uQebX+qfDjlMYVTiJsyJTi2KFRp/t54Vu0c8qvmVdslQ29es6t6EvvoP//698eYATk7XwhgY247J4+NUB12ExBcV5IQkG8kHVmOHIqlRTrtawWjBTQF7vTALHtuPgoo+NsXPClnSRssw820gjTMCgXln4jnuUrVTCKMLHJYAL2Ps1wsWAopPSVAF8MwHdxPwDuNPTL2f1oBw/HCSioRAbCuQ+yVYobNDPCj7ZHxtEpTjCEJkIN0Qp2T20v1YLoCDBPV4eMRuD+Eg4PBcEPmi8ViwOnzAOrYPTdX770cnbz47vxFH+esGpi90QNGsUTFVebba1gaQ7nVFxTgjwaHAzowwjQA1AX02D9wYIvug7UgP+/+lG33p2y7P2Xb/Snb/P/3T9lceYMv9iB/Qz25cjH6zlXOP0U3B7ZEgdoZfgTgwRwrbBhwdzcB6UK1s1rha4g9JdXsEJJ5SXnMVvC+UqVye70C2BqEd7fcdrfcdrfcdrfc/oe33Dqj4jU1Jxt33Si9wgfCAOwYd0Ol766J+REbfV0z45jU+M6xIbSBBRcMnrg/Ls4I2IlKvsC7d/Dfo+hn+B8dSlHNTmASvr+LUuhSKmgYYYxdF1sp7lrsBl64JnjB/cB47T/ly4DKdaTBMoP/RdY6pzxDHwYveV4Pt1+2Tqh7czsadYGHQv8FU87Gjw==
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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: eJztGttyG7f1VzB8ijO86WLHZjOZKpKasrFrj0XHbWyNCO6CJMJdYANgSbEavvVL+mn9kp5zgL2Rq0r2ZPrQ2A/yEntwcO437F0nFpkREXci7ozmPLGiC0s2MjJzUqvOqDNZSsuEijMtlWOxSIQTlnG2EbOl1qs+mywFs8KshWGxtHyWwGsHawGAcRWzlJuVZdIxbgOKuM/O5g72IKhf6ja2WTjTMqVZqo1gYi2Us11ChlAa/pgStiAPkGvY4thcApx0njgjbKaVFSzSynGpmuRJBYAWd/CEWQeS6He6HZ0Jw1ECY5BLBzbO5eKCqHzv9wFMxg1PYcXYzujD3YHYBBtfMD1vHOZ04BXPELc8zRIBwM+e86P5cXQSn4qn82f8m9nz6EU8FEcAJBFZxt0SnhUcB78CMqCs2zHi11waVJ4zOejORkuR8s7oruO2GQJbZ6RadHbwym3pMCvp1F13n+TX9MCTPnun5K+5YDIGocu5BEkHPizIf6ZvmTYLrkDZuAGZykG6c43KBGNBmoQF4b9fCsW2Oidd+ndLwWNhvKbRaGQE+smDSkqho1JwARUmbl1xOvIft9KACLljEi1kgSp2Xuw8AWH77fC6lXq0KDSZ+r4UHhubRWNPn70UfC1o3TPEdO4KOewh6H9UH9Wkzi7ssHVpMK2SLdsUwuI5YAC5o1OyjXRLcLaZ4AYAeRQJC3v1SqiaeFt2KHb2ZsxWYtsUteOr4J2tspgbndLbsJmEIxcKPLBBMfiVRrWFc3oIGgG3qDd+j4JmMrguAoOo7iWCGJi+eTdhg/XxwLvegMepVAOeSdg9uIP/fxTbcbwbBAw9wDBlqD+gjyQ+/VvvKp95FYxjeGdDpCnCHVmT126dr5qw0PqkypF1TaLPwMIccAK6RvT+6Ndmgfg3GFfkvDL3GYSogNZWNtDGcJqD2YlbaQE3Pc9EotUCTwVs5tBcAxAyk+gthVLFcrVSeqNqTovRcs+H25VTOA/5QYHUx9omBoLz1HmhQMSfz4UBgD0qwRZSsDXvxfhrzmXiVfvnyeQNOx0O+0V080Kq4ltTtI0gFzLUf4ly9aD6/IU44qfR09nx/GQ4HB7xk/ibo2Fnd40ofU6wiOR4OMT/KNooh488yxJ0J+Bl8IvF6HhXOzQzGKmc9LtDOKZtSfJ6TsmgIvlDRyIPOvCS8W2iefzOJPAjnDhBJoCrfIbheCbiS8p2sBQSKm60IjLCgdnj80pmVzb5SRjQiycTVp1MIewC+x1gMAhGz34RkaOXjqRSpa9m8D8rc5T3uDxE4tbwV/cSnmz41oZ0DWnabCGXiiQuXcuT0AULJw+a2rrfoBE0xQnSOtDrPrH35qeiKHlcdt0Vavn8Aw/dCHzQNmnB3Fs36M8/rc15m9rwaiC5By1gbsHUzKsi5MCLC7ze91M4FkJKCQ8BU8g1hEHChXT4agypwtIJo46NQIfEas3AH2b07UtPTXlEvVgKmJrKXDqX2dFgEFb6kU4HCG0HcmE4eO+u6VYP0nDugRlC7ZdrdQpUnqIzH0SGbmPptrfZbHog77SXm0SoSMfgvde7Fu+uKDtw0rZIcFBdkhKIbOuFWKe8EGgXU/IJWxidZxaVCmlUpnmKnB4V7J4wbgw6MSWWpQaz4U3A6qymuRkxh5LHYpqoQBrpJFRyCWS3wl6ImCaeWAsPbkSqobKKcy9SwdY8gQx8GCYijN7KveKKLwRa7PsqDAexElNt+saNkJ6KnXVJElm2svAoggRMpRlmQhXLtYxzaBQW3iFMKYFATxfXuF3ZqtTvAncbhXaE7/IsRrZAJhL6Je44pUEnUvuwqV6VZuHpq5klYfK4+6A4J6mj6zbWI64ikfhsEsjtQ8bSm8YKppyDRagw9Y24zaTZFkhDH3NwWMFsyxu/o05Gc0f15nq3w+S3kI4n76mGe6x6L/ymonpvqPaSstPr8cXpT+fhDemOwiVZ5R/IWKdgaErG/a+nwfzAP3wpQxEwrJGVg1V4fGNU7mvYh7/egKk4sQgpVAkRe8Ni08BTaA2qA6qSj45JsC24GF+c6zRlYPhORzopq8iCPigIKEVAywaYgsnONWqP0Ehrc8BjIZFQ8VfRCrl4ydUieHOBb0nnPojWgxHa5n4ordFafFr6ur8+2d+NFJQiKmgYsWnoGG9w97Rb/Q5RDMprrEWndfw3PFrhC4j/oupb1lQRBeK6Lbvg9Bhc69EI67x+VL+Jqx4qT2MNTcz7yUPr60IWrSDV4w0p/UEoYvZhIKzYHoYLE51WMCQH3RqAlLwHhvrZA8IPrbF2ZNDjI6H3uH0Adp/phlnXTRUs/AGoQmn3Qx6a4CNhgwQQ2kdLCKWvuFkJlyU8Eo+Ol7CNxnNh3+OSYX2mALLjzidDn2hwOojU4DgwSrTNIXjyhRE+2YJItIl/u6xXo72Pv2+qU2/KU2/8qSgpn1lCW1UdPtM6EVwdnE5DlikO16bd1goLR5ReZuAGEjOMr/jLdu1hBgnUz0WKOq4Qrs9PGnvoKE9C5YDTh/EPWO32ruRCcQe8Tsth0pwJHi0rau7rDyjzYH0WAePQ2+OgTarQwlVc+j65y6ymRASFKpFQDlW5pZlH/R1w4mXQ0qZ+hsQPikSK8r4Tmby8YhFWhXNfLoaKNhTuDBoMoqRqjR/uSSbnDMHvM/S4bgVUXk//Dv96r171Li4my+UoTUfW/jzFpivl7p4616e+uiJothM8qNnyHA+Pn/WGz3vDF5Oj4ejoaHR0/HMH7Pi6rSsop+57w/Wy/vCWPw3tIRwfGngvcZDWrtuYXhTjjYOZgvek5gT5RyA8zLxA0ghwOjz6pNlK/WhhjDbn0EGhOPD5onZay4yj2SFUuyudU1lGs6ZSvKfD4a4FfYudVBr5HkxLqix3rLwDQHEcCuSdwtmsNvIflFD2RXP6OxbNW2F1bsAn6L5G5yr2JtqYqCw5xdfCqGl+iDaN7Zdi4wtqtxq3OdX90oG8n37imO//S95jOM/QHZe/q6Nj9mTk81ZupNvSFPOM5uzweI23Rd/TJcQZGDStINd8gXdf5VARloCCpcY7M68Gmnjihk5tmB+UNbgrb7J2NOBEutru0i5EqgPZAJfjZKmcA8Xwrscz2ffjn77ULTdbV0AoCO4+HNa/3kdzXUnjCo3C67KQSVVX+YV7htlnwf+LIe3e1LW4Z6lucMqRXkgLPqFNG3jKZF/cBEBlOJe3kJv85YmnkU3ZV+BcvmRwhsuEZJBBpfSky0R/0d9DO2Jh47d474DiwJud76aUQuvav+v4C6k/UYoDPv7yfnLIW+2yCozT2oI8jynQjAm0QQQrJUieSJUCbeiUXoZ6ozwl1VwXLs0jcmnwXZnQCC3LtHF/rPRZqkT+UC01DaFuQ3vclJvYV//+57+eUOJkVxsBCXXpq92in6XWcl2recrsD0FhLemaaRwmD1Yk857VAC2gkAsTX7fthv2YqlnVm+DtJoubAw48zOpExizTUJqIaKl0ohcSR39CAQLUOWdKbFgCpV1CQzgMBXTZOgObcP6aD0c8oEwEhxYY4iJ2bV5hxJ4RCyxAgR/rr/nmeZKg5cZADtKZcqWANxAqxFQBpSGqo/ACMDowwuP+8EDmm82mz+l1H0L/IOy1g5fj88u/Xl32cM+uGo1WekDfiXWUp0VLBKgxgHh9QdF02j/p05A/09YBdTV6/FV+kTX2TbeWI36nnz8ER8OeYACtFUS2XdDbXYjnHzrrYz8ghIgOD5UoR9X3CRBBlyB7hL67m3Er3plkt8NlaI8NJRbQGTdk6D7wl51Z28codcV89Tak5yfsEd9atDJUBHCF0ZvCLfyCxxXG99pnFjuc34ew9GlEfvmk4ssnFV8+qfjyScX/8JOK1kjnI9rBhxVlzMOS2cOckVJq7w56pF29yr+4fHk5ucRL0FAYVkXxiori8IBhszXc7tfHngr8izS1bvkWXQmM9bsS3L+5d0NZUXpoFAkOAv8DvQqReg==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztGtty3Lb1VzB8aZLZm1ay46iZTFXJTdXIl6nkuI3j0WJJ7C4iEmAAcleqZt/6Jf20fknPOQBJcMmNZKftQ8Z+sLjkwcG534D7KBG5ETEvRBIdL3hqxQBe2djIvJBaRcfR1UpaJlSSa6kKlkpbWMbTlBUrwTZivtL6xjK9oN/aLLmSluPSEXvO4xWThciYVPQZF8Naq9lSroWld0bYMi0qBCkHiJzfpZonLBEpgJk7VuhwtxG7gh9WGPjGEg14lHaE4QoBnNR0jdgbK2jtTC8WVhQzxlXCZqnMJDz/XCL2nBuewTJjcaOcL3GF0eVyVRM9+lH9qHBXJTYC9vH4Wawz2H4hDYCEVBmRpzyGT1w1OxcrXjCQZSossg6fJkQNr+mpICYgSAe2kYWjIhELjnJa87QURE4j3ZVOEydMK2IjCnYj7iqBVpSCBuJUcMMKcYvsRINI58KQps5B9VGs1UIuL4DZt154ANKIJjp+d79jGC/LbA68wkZgQNokJD57I3O2APJBjlJ5QzgBuS3heY0WwkplBE/4PBWOGwZml1o25/ENYphNZiPYWuIWpCD4oYAK+OkkCb+N+LmUJjBZG69ExqPj+6i4yxEUbFUshYnQmkly0fFkEGVSyazM4Hm7HdxXaEn6u1u2eX3Bb3EhU308g8hLoxiIk6xn9LEEHjiq2ju/ogeegikrCcQxmQhVyIV0ZJDWwYrm+rblfUhXCbaPqijQg5EigWb6diUUu9MlGAsYH31bgT6EGXgTMmsZg1+WytlUbSaVF4OloBFVu6MQk14aBpVBDxhfcqnAccgkQd3CL4fPvdSjX6BXh+syeGwt3o03F4Kvnbc7hpgui0oOOwhqh67ZhRU2lAbTKr1jm0pYvAQMIHeMlM4rOZuDPwEgj2PyaH0jVCDenhWKnbw+R+9si7rgNz4Y9spiYXRGX/1iEo5cKm1Ei2KIQBrV5vcZImiMkRq45nsUNJdkA4Lw+jDbSwQxMHv95oqN19OxCxZjnoBDjXkuYfX4Hv5+J+7Ok+3YYxgChhlD/QF9JPHZ34aX5dyp4DyZYaxzwa3KQWRNTrshX4Gw0PqkKgV5Hoo+BwsrgBPQNaJ3W78yS8S/gc2ZXDTmPtfAhkNrGxvoYzgrwezELcTDgXuei1SrJe4K2EzXXD0QMpPqO5FA2FMQ626U3qjAaQeonrYP9yunzgboBxXSgcsYLQwE56hzQmGJXCyEAYAdKsEWMrA158X4a8Fl6lT756ur1+xoMqlDrxNSE3vbon1UiLOFkWoZbQeRuOVZnuK7p8+efSUO+FH8ZD5dHE4mkwN+mHx5MIm27xGlzbWywiKS6WSCfyjaqAIfeZ6n6E7Ay/gni9HxPtg0NxipCulWN+mHVqbpqwWlME+anv8kYoz5hSyIrtcN/GAHVVwalCVAiD3xO4zXpw7a1REuXUSBAA5AGoUueHoOmds+At8VAgd5BzM+1BVr0Bym0BD39EmFHGn9GORINGZiC54IBlMlxnqHQ9jAvXwY98sdkqv02JLGBBCuuH1txFrqMiR5rjXUK6qD9lwlFFLJr8GQjfgdiIPlHkNnCzJOt8tLyFofv4PCnLeLvTCl2G7RdneLZhFUQCzhBfep2BeU6BVVlYo0dZc3tbXyhTIlcNBMVWTIyoQa826c8l0k0Uu191ZfU78xKfzwPnWFcgC/Lee491wkz9fwFuu+BEIGGBcudCUlBHZ8huLu0qbfCwORJ668pZBQBBcgkAjEsM+/fFHZEfZJUEtjTil9rdGb4MM8wNMNv7MU1aE9oTYBomGa1MnDkTCAGE45YmbDzDDqeDlIqxO5dondW4FVnUnUDnX8YDGND5Mj8WTxlH85fxZ/lUzEAareqeXjN+wmCsgytk0LbBPy/Ct260tPbW04NZDcvRawekKL57WCu3mqwuuyWwbbYq9QwUNJIKhNJFxIhyD7dCHFIsfMxqBDYjUw8IcZ/euFo6beImyVPKa2MldFkdvj8di/GUHnNyb3HMul4ZCftm23epCGUwfMEGq3WQspUNiuvOvmvkHr1e1ws9kMQd7ZsDSpULFOwHvfb3u8+3h/EuyLBJ24REogsq0TYkh5JdABFp2HbAltdG5Rqb7zQk4PKnYPGTcGnZhKJ+xiwSZagM1ebXMzYgFFPbXXDUirYAonDt5eiJg2nnp6YESmoXdISidS35nabpiIsT5RxQuuIAijxVaBrRErMdWnb1wIBVi1MpQkkWUbC4+h6HDNB9Z6kJDWMikhVbu5iTa1BDw9A3zH7Q05lpuCDIC7jaJBCjbdeYJsgUykoXTUSiC/bKqXtVk4+gKzJEwO9wgUV0gaJA1a72OuYpG6bOLJHUHG0pvWG0w5nZfQQ+lrcZtL15IjUsdcd7OK2Z4vbkVIRntF8+U9NOCQ/JYSyqK31KU8Vr1nblHVn7ZU+5yy06vzs6PvT/0X0h2FS7LK3/sZVS6UTEZfzLz5gX+4Yp0ioH9HVg5W4fCdo3JfwTr89ZpRMeZTqBIicYbFZp4n3/w2GzRNDW2TYuN7dn52qrMMSipd6FindZ9U0QcFAaUIniImb7ILjdojNNLaEvBYSCTU3jS0Qi5ecbX03lzhW9G+D6J1YIS2vR5qP7QWl5a+GK0Pd1cjBbWIKhqO2cyXVNe4ejZofvsolvhpYYj/msc3+AEnf01nvqaKyBM36FkFuyfgWo9GGPJKw7pf76pd5WnsEol5Nw3s/VzJohekebwmpT8IRcw+DIQV28NwftrbC4bkoFsDkJJ7YGhi0yG8a43Bll6Pj4Te4fYB2F2mW2YdmipY+ANQldL2Q3ZN8JGwXgII7aIlhNIX3NyIgkbej46X2BFlzbrHJcNwagayoyatTm7YpFGjBakkTrUtIXjypREu2bp57X8v6wW0j/D3dbPrdb3rtdsVJeUyi2+rHm5CaYw4w/ZyNuitsKBs8TKrjklcxV+3aw8z2BwW1HVcJVyXnzROieIy9ZUDztfOv8Vqd3gpl9DaAq+zely6YAJPJGpq9vUHbubfOo/AX66Fa7h0k6ABs5oSERSq1XERfYBih6Z64TfgxMmgp039CIl3ikSK8q4Tubq4ZDFWhQtXLvqKtjq5ggaDKGla44d7kqtThuD7DD0JrYDK69nf4d/wxYvh2dnVanWcZcfW/jDDpivjxZ4616W+UBE0vfQe1G55ppPp0+Hk2XDy1dXB5Pjg4Phg+kO0pSOKndbZXnBbnHnFX5Y0D+8fanzsaZ83GusV5CczDkG9UGI5jMSDQrifa9cHl1R8Q8sJYaxEuMRn2+lkgjtOJ8+ohp5On+7sSOeV7W39KV8Gho9uuIdyVkJkTwFg05IrYhrsGiNGh9bspleknflKd/DUtM/10WEjc+yCemU+6k5q3sLyFg0kODLqMK7vEr4JDw/rkWqXcAqH7YOu72CNH82D8SDA0eTgg0bAISHCGG1OQc0oe3w+C3brGVS1TbpZ3TforHV5NMEBZgd9j7M3bvVHkLtUeVk0B88ojq5A3ig8QtJG/oOqgrZonnzgdPy3JZpz2M8oaLe8J9I2OzJyybA0srij0egJHU/B43uMYH+ks7sTEDC9Qa75Ek+560klvAIKVhoPx5d06pxzhI6CA7DA2h0lfefkZyLTnlCAK3FAVY+TEvg25LkcuSnSSOqoewQMrgeetNyHw7rPu2jeN/xfohk47VVSaMoz92LPqc+Jt8Bq1rsTbKoDyeaos54M+uziAuashaeuGaojMygwF/IW723QKaOjkc3YZ5CyXOVRGC5TkkEOBdfnAyZGy9EO2mPmF36NB3QoDjwC/WZGmTjU933kTm7/RJkS+PjL26sub8GpLpijtRV5DpOnGfNwiwhWS5B8j2I8LYhqv0K9UdyUaqErJ+YxOTF4q0xpEpfn2hR/aPRZq0R+27xqG0JoQzvc1IvYZ//+578+p7zGLjcCKtKVK5qrtpgy5zooneoiAsLAWtJ57LkfYFiRLoZWA7SAetAPjou7gV9PVzyaFgevAbCkPSfBzaxOZcJyDQlbxCulU72UOEEUChCgzvHsZcNSqBBTymLo/HQrYQ42UbjzcJwUgTIRnGoAic2fUxixZ8QS61jgx7rz8EWZpmi5CZCDdGZcKeAtwgOuWECFieqovACMDoxwOpp0ZL7ZbEacPo+0WY79Wju+OD99/vLy+RDXbJvk2ugBfSfRcZlVnRWgxgDi9AW119HocERnBbm2BVAX0HPh7lGlLIg/STvI1onh0/2t3+r9LR9O8MUYyIX4vfXWee9T1btoPXXTVEhWUXDgCLlhBVaFEPf3eNz7xqTbLb52158oidXNat+1wNDC/rcXwXrZvMEc1twHo+XwwiXPRxP+obe6foGU6qi8oeQ9/jAUBF3RUSXXDxPup/tfn+5/fbr/9en+1//x/tcvhLnOLbBW5HUwJ6SU4FunM92GvdW3z7H45r4yb7qSG+pK/ENwdYuruwD3boPiSMD/kaDeJV+jH4GlflODuy97F9QlvYNGeeBA9z8+ectU
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWM1y2zYQfhUMT01HphwnvXgymSa2m1HTNJnaaQ6Jx4LIlYSYAhgAlKxqdOuT9NH6JP0WICXqx5WTY6cXGwQWiw/78+1CiySn0lImPeXJ6VAWjjqYcplVpVdGJ6fJ1Vg5QTovjdJeFMp5J2RRCD8mMaPB2JhbQVPCmp+X5DAvvZibSmRSC1cNWNeAhDepeO+It+HvVBYVZJUOavorsfyCNbm+GCoqcjEbk466LAGiMFZUZc4j2ZydiitoYFhCuaDNyQmJIUQZpbEjqZWTfBmXftKfNIsbm5MVZhjk11hIZmMhrZVzkY2lHmF2QH5GAJFBmUvFuRHaeAGjwSLCRPhBG3QnncSUZMNZPZgzyYweqtFvJPMPEWy43RWbCbKWXAlQGJ8ukpPjY/6HHR4iPJRlWagsKOt+duyKReKyMU0kj0rLR3kVd2esR/s3UssRTTDaPQ9S236lDb+xxWo9YrJSFMzrakknTJZVNroF3lU6V1OVV7IQIzWFDqiwNKxwp0ZVh+eku4VrDMxWkKeOyM1MF0bmLX/CjsoKDGUK0yhPkwCZoQGr81bpERa88gVFyx66cCchXU2S04+NcAoXmhnivLOeqby5obtS2Tlmw+kRY6q08ipkRT0fce7ON3dJEe4ZFcXOjp351Y5dXfHs9o4GaY4YruFfLzuNXUKsJsu4/Y20t+TLQmb0je7nYGZN8P9K1f0BEHKN7BSZFNMTvBC3A2xWGFdZ5OnIUnAQAiNDojzIuwdvs/Yti7bR8vfN+vyb1fk38fz91lMj5WXxARamb02dYLuoR8yCor2Wyyu+KwwFx2rKWGGHvyzlkFLYrJyrOABC4rQXYGg1rBmhxXpMGVLpyH3nvfMzM5lsoJNgKl57C87qnT/9/ay9+jB//Lt9tivGiy1DtM6LuPvgLq3y9Pt+Q77SUsQYAPYC5gbvuw28UUF9QG3otZ4BFQbmBdcEYi6Y5hubgDK9yUyRtsKnBrK2cmqGQ7I3nHORzvcuI5YIhJfvFVkPb9iXh6VkdvsQoYxKf1gucsh+sSa0IKTVPTLe3JLeAT4OprznSK6FMWAeIr112wOy25dGs8K+iUlg6Quc7oO30umTA1KN0+6XbH9EnA+UrS3A0rv8suRS/6VSllusjw8rXYcz7hBFXq9gmMFnEA1wLLcT9e1raBqjPSHL+c8CT48ff1Uf0r4ZWWvsmcmJE4zH563TdvB0tnqY9e41E6HjpBFZ1ncnJyWT0dPj4+Ue9XvYa7UleYlWQ+my8qKUFt2hh8rlco9B3mt0BGNj1R8h5jZN88NXtmj/LdP0cJ7V4PS65IdjtmyETY5Q5ZSf49KL5EWpXhMPkRSL5CWB5e0LGDjM8K3lyLF16uhlQwDB2HDvPKJgB8nSSXd60o3NdLdu+103FIUjX+dDROXCsZvAz2liatCQq2yBubH3pTvtdnOsHclSpWpkJThEmYSRbiq4BEyu2ffocHF5W8312haXHBLRk41FVi6RcQJFmI+KxsSXhiu4ktbRGEJst86+64lbmguOWSbMdmsQ6mHzwulv6OmLeIyYVGgf8DQDlQ3VHeG5pfwYwgGS6Ivv8NSJZdlbqYpggxJk86gjKB2lW2pPRb3xGR5sls1xBHDP+yl3WG3fL5JB+PrJ2IlEHiU/f7javRuY3/GjAdUIoelcAy9qqjHzo20DhFhZMOQh2zAelqxyjP0WSFnpoWkSWmYhoZG5in3rqrI01v+49ufKJerVemozENoxtHWb1Sbx3d9//vWIX6pSXKKZV24cW2a6iy/O0Pm0O70QdipjLxm8tVAqRc+L8MRyVAyPnIE0qRFeY6Fq+nmn3i8HBbX6R8d95lZjxoc5U6hclAZNImVjbQozAu3AxRoKYq+qaSYK5FvBAcXEE9hJDhATfh6U8EMKzmTxzIBaVOhgg8PC9SyNqiI+wtlnUgyrouDIzQGHceLFqXE3GBWMSqiQ7I4mCxB0CMKT9HjH5rPZLJVhOcVLv1vvdd1femcXv15eHPGe5bqRXfuBcyc3WTVpajhUM4FEf50cnzxNn6SPeW9pnAe6Fh5+0O/76WM7iFu14v9fUb7mV5Q6Uz3d+S7aG1Djsnb8oq4IH5PpSXwdoyZg0FQFrm2tugASHsN9LL9YDKSj97ZYLnkaLaENlQlulzbkSqxTDQdzIbllqg5UVHIxClcMnL1V9pftwvXqgtlM1lS3pvnbQPP1gLU3S3re0r3N+BEC/+XCtHfLM45lEO/zlXhcuXfDiiOjNJv3GsX7Hy6MKC4=
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: eJztGtty27j1VzB6SnYkSrKdbKLu7NRrp6m6SZOJlU27iceCSEjCmgK4AClZ9eitX9JP65f0nAPwJlKVk+70oU0eYgo8ODj3G3jfiURiRMhTEXVGcx5b0YUlGxqZpFKrzqgzWUrLhIoSLVXKjOCRZUO2EbOl1rdMz1m6FEybBVfSctzDZlsmU8vGl0Gn29GJMLQ8hgM6oVZzuXgHSD44BACRcMNXIhXGdkYf7xunC0CUH5OfmmoiBPGLO75KYgGgT5/x4fwkPI3OxJP5U/7t7Fn4PBqIIQBJRJXwdAnPCg6DXx4VUNXtGPFrJg1KIDUZCMCGS7HindF9J90mCGxTI9Wis4NX6ZYOs5JO3XX3CX5DDzwO2Hslf80Ek5FQqZxLYXIuLFfRTN/VhQYsZVawuTYAAxJHmoRNA/ZhKRTb6oxZUIJ7twTehek6ZMKsZSiYyZR1qsgFzqSiBZB5Ku7S/HTkP2qlARHylEnbZXzBpbKpEzqPY+G3w+tW6mGNKZ3W9q3gsba5biYBeyX4WtC6Y4jpLM3lsIcg+KQ+qUmVXbLDijSYVvGWbXJh8QwwgNzRstlGpkvG2UxwA4A8DIWFvfpWqIp4W3Yodv52zG7Fti7qlN8Ke1iTc6NX9NZvJuHIhdJG1CgO2ESj2vw5PQQNgVvUGz+goJkkGxCEF0R1kAhiYPr2/YT11yd953Z9Hq2k6vNEwu7+Pfz9UWzH0a7vMfQAw5Sh/tC3UOLTv/SusplTwTiCd47tMmaQNTntVvmqCAutT6oMWdck+gQsLAVOQNeI3h39xiwQ/wYOZ3JemvtMAxsOrS1toI3hVQZmJ+6kBdz0PBOxVgs8FbCZprl6IGQm1lsRBexcsUzdKr1RFaftonrqPtyunNx5yA9ypF06qo6B4Bx1TigskvO5MACwRyXYwgpszXkx/ppzGTvV/nEyecvOBoMgj25OSGV8q4u2FuR8mP83Ua4aVJ89F0N+Fj6ZncxPB4PBkJ9G3w4Hnd01orSJVlZYRHIyGOAfijYqxUeeJDG6E/DS/8VidLyvHJoYjFSpdLt9OKZtcfxmTqmgJPljRyIP2vOS8G2sefTexPDDnzhBJoCrbIbheCaiF2tYtbAUgUBnscCNVoRGpGD2+Hwrkysb/yQM6MWRCaupXEHYBfY7wKAXjJ79IsKUXqYklTJ51YP/eZGhnMdlPhK3hr+ql/B4w7eWbB6S7VqYLQNbiaPCtRwJXbBw8qCprfoNGkFdnCCthl73iT2YnzwPD8yuu1wtX35g043AB22dFsy9VYP+8tPanLeuDacGkrvXAuYWTM28LEEaXpzjdb6/gmMhpBTwEDCFXEMYJFxIhyD7RKqwWsKoY0PQIbFaMfDjjL575agpjqiWSh5TXZnLNE3sqN/3K0GoV32Etn25MBy8d1d3q6M0XDhghlD7xVqVApWt0JkbkaFbW7rrbTabHsh71ctMLFSoI/De612Ld5eUNZy0LRI0aktSApFtnRCrlOcC7WJKPmULo7PEolIhjcpVtkJOhzm7p4wbg05MiWWpwWx4HbA8q25uRsyh5LGYJkqQWjrxlVwM2S23FyKmjifSwoEbsdJQWUWZE6lgax5DBm6GiRCjt0pfc8UXAi32QxmGvViJqTZ940ZIT/nOqiSJLFtaeBhCAqbSDDOhiuRaRhmP2cI5hCkk4Onp4hq3t+RYkYDiQ3SBu41CO8J3WRIhWyATaRg8ckqDqVjZ46Z6VZiFo69iloTJ4Q5AcamktqhbWw+5CkXssoknN4CMpTe1FUw5jUWoMPWNuEuk2eZIHXPNw3JmW964HVUy6jvKN9e7HSa/hUx5/IFquIeq99Jtyqv3mmpfUHZ6M748++nCvyHdUbgkq/wdGesUDE3JKPhm6s0P/MOVMhQB/RpZOViFwzdG5b6BffjrLZhKKhY+hSohImdYbOp58q1BeUBZ8tExMbYFl+PLC71aMTD8VIc6LqrInD4oCChFQMsGmLzJzjVqj9BIazPAYyGRUPFX0gq5eMnVwntzjm9J5x5F68AIbX0/lNZoLS4tfROsT/d3IwWFiHIaRmzqO8Yb3D3tlr99FIPyGmvRaRX/DQ9v8QXEf1H2LWuqiDxx3ZZdcHoErvVghFVeP6nfxFWbytNYQxPzburQ+jqXRStI+XhDSj8KRcweB8KK7Ticc+x2MCQH3RqAlDwAQ/1sg/CmNVaO9Hp8IPQet0dg95mumXXVVMHCj0DlSjsM2TTBB8J6CSC0i5YQSl9zcyvSJOaheHC8hG2QC4t9D0uG1ZkCyA6ivC2Tm8W+ENFCKgljbTMInnxhhEu2IBJtot8u61VoD/D3TXnqTXHqjTsVJeUyi2+rysNnWseCq8bpNGSZ4nBt2m2tsKBs8TIDN5CYYVzFX7RrxxkkUDcXyeu4XLguP2nsocMs9pUDTh/GL7Ha7V3JheIp8DothklzJni4LKk51B9Q5sH6LATGobfHQZtUvoUruXR9cpdZTYkIClUiIX8BxQ7NPKrvgBMng5Y29Qsk3igSKcq7TmTy6oqFWBXOXbnoK1pfuDNoMIiSsjU+3pNMLhiCHzL0qGoFVF5P/wr/eq9f9y4vJ8vlaLUaWfvzFJuuFU8P1Lku9VUVQbMd70H1ludkcPK0N3jWGzyfDAej4XA0PPm5A3Z83dYVtHbxIINdtzaTyIcWjUmB84/6XPhHIMdPskB+CHA2GH7WxKR6tDBGmwvoi5BJfL6snNYyuajX/eXuUpNUbNEEqRDa2WCwa0Hfov1Szj+AwUiVZCkr5voojqZA3iucuGoj/0ZpYl80Z//HonknrM4MWDoa+VxnKnIOUJuTLDlFzdxUaSqIToVNlWLjS2qiqrEWnMTXGEFD3k8+c3j3vyXvMZxnFPQ7GGEg+tMxezJy2SgzMt3SbPKcpufweI13QD/Q1cI5GDStINd8gfdZxagQloCCpcZbsIUgOeB91KhTmc97TfXvi8upHc0skai2y7FL6PM9zQCX4bCoGO1E8K7HExm4iU4gdctl1RVQCVI7hMO61/torktRXKFFOEXmAilLJbdwYD597p0/n7vuDVLzq5PyUqaY0vlI73LUtIanyN/5cB+Kvbm8g3Tj7kMcjWzKHoFnuSogNVzGJIMEip/HXSaCRbCHdsT8xu/wKgHFgZc1308pK1ZVf99xd0x/oKwFfPzpw6TJW+X+CSzT2pw8h8nTjDmxRgQrJEhuSMmfNnQKF0O9UZKSaq5zf+Yh+TM4roxpKpYk2qS/L/VZqES+LJfqhlC1oT1uik3s0T///o/HGGU4u9oIqA6XroDNW1TqFteVMqZI6BAR1pJujsZ+mGBFPO9ZDdACajM/xE23Xb8f605Wtht4Ycmi+swCD7M6lhFLNFQbIlwqHeuFxGmeUIAAdc6ZEhsWQ7UW01wN4wDdn87AJlJ3c4dTG1AmgkNXC0ERGzGnMGLPiAXWlMCPdTd38yyO0XIjIAfpXHGlgDcQKgRUAdUeqiP3AjA6MMKTYNCQ+WazCTi9DiDu9/1e2381vnjx56sXPdyzK6edpR7QdyIdZqu8ywHUGECcvqAOOgtOA5rbJ9qmQF2FHryZzxPGvuFW0sN/+lGAt1eslvvQdECA2Hn2731Y/NhZn7jRGQRGeChpGpU39xCIlsACQt/fz7gV70282+EyNI6GgjOwzg3Zi4ufRc/S9q1DlcNH73yKe8yOfoPQyk4eBRWGQIpZ8AsebzFIVj4/2OFc2/v255H49VODr58afP3U4OunBv/FTw1aI52LaI0PDoqYh3WngzknpVTeNbqMXbVOfvkCqyfuS6uyrLylstI/YMxsjbX7FaYjAf9Hglq3fId+BJb6fQHu3hzcUNRkDhrlgdOxfwG3F/iR
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztW+ty2zYWfhWMfrUdXWzn0tTb6axrp43bpM7ETrPbNhNBJCShpgguQdpWPfq3T7KPtk+y3zkAeJGo2Enb/VMlMwmFy8G53wje9mKV5SqShYp7h1OZWNXHkI1ynRXapL3D3sVcW6HSODM6LUSZxVhrhRTXajI35nIoLuZK5OpfpbKFmJh4iR9ZIiMsKjCTyWViZCxev3re54HIpIUCpGKZKTdiywkdOFGxUFeYsm441lZOEgxOEznzK1WUq0JcqqWQacxD5+fPxZXK9VSDCGDMq4WZ8mQLxwYmYlECWVvIvBDXupiL8bwossPRaCxM7n5Y+tXnY1IjDKDlAVyAbvKZTIEkHxvJVJRWCV0MxXkgSBQGnFroVC/KBW3bdxQy8cNf0l9S5q4mfk7LJAmsW2BNH+cWGM+ApJaJ5zyAQxYEJV+KqVZJLHC4+xnJJPFAiVX5lY4UeKUyJ4mxjseOjWNgflr9sKBxYm7OeKzi67jQC0hULrJxoNcWJoc4WkxtLsN/S3cUpOS4QrNAqdfvmUzlPHYKRetBCaZ69ppJeuPgYQ1IlQtVqNz2Dn++3dBDJU5P1iRLDPaMwX51AzwShcWPn8j96UH0IH6oHk0fy88nT6Iv4j21j0WagGWymOM5xXH45YEBs36PNFnnZA1FXsIYbDRXC9k7vO2RzLDYFrlOZ70VpoolH2Y1n7rqr6N8xg8yGYrXqYaBCB1DsFBV6FLgqWN+W5eIKKjSFLpYkH546xqKN3OViqUpIV0WE+bmSsYqD+bhZJ6XqZNDxXSh09r4bopwOtEfd+JAAGUBzYQJzKROYS7MdqiY8tsx3Ym9M5mitW+Bx9bmtvUMxXMlrxSPO4KEKYvAhzUAGyoOZYttkxswiWQprgOzZAkI4Dt5OWfuUkyUzLFQRvBT2GsuVdpgb8eOVBy9PCXP02Z1IS+9o+vkxTQ3C571m5k5epbCkFoYw5gMic2fM6ClZM4kN7lFQBPtTZUWg1VbkXAe7uXrCzG6Ohg50xvJGG5pJDON3aNb/P+9Wp7Gq5GHMACEsSD5AT/m+PgfA/g1JwJyFNqRXccP1iYn3SZdDWaR9um0JNINsz6DhsHRTSBrAt9yRNc4XOhpre4TOGEP1tY60EUwe3d1oy1g8/NEJSad0amAlm+qq19ExCRmqeKhOII3Ty9Tc502jJbCwZoNdwsnGA/bQQDqgkkbAq9z2DmmIOpNpyqnGNHGErqwgK45K6ZfU6kTJ9pnFxcvxcO9vWHwbo5JtX9rs7bl5HzIf4+XazrVJ1+offkwejQ5mD7Y29vblw/iz/f3equ3DiR81NdIAAiMj/L0KLMs8cF59Kslx3jbOC/LyUkVWln65T0xb0uSsynHgRrbn3s+iL/OE5DhD7kglEFDlUY85SyChjhfgGb3gKGnzEx+VVGByUIXTNYxBSt1lq9Ho83wE4KOM6Eyr7w1xztyaY141NL8YPIuBlfxtyP2NgNqU/sh98VQnBYNj9PtacZu+DcfbMfBEim+tnjdYOWG3LuoJzU7JxpZ3yiLYu2F9St95VEKHPKwHROuZILYd8+Uq2WPpQubLhCuhYxWvA/b/cgwMosRIWJHepZL6OGqrS33IriZqa7nHRWB3xD2TRW/GVxfXw+A8mJQ5olKIxOrkGt9d372Q5WHwj1YAu9cPJBImNKFT+tcbB771WOmNy0XZAQbFtXv3YlB7+2qw0RqPmyYRYc5bbKozmat04Ymj4Jm9InEB2KWmzKzcK3thNgz9oGQeU75I8t+bsCB7ZmzaIf/KbIES561XtLywD75SRAQCJQurEOmDSc2yi3P1cIgGYlLx1KvwHbTgqAgJMEXMpUzztnf1O7Ls5WJ2mDdsdsIjx52NjnJaFnPXCtMFCFmcTZDwSON9ZWOS1QEMzY76F/ggMenT2PSXnJEiRXiNQqtGKGM1Q5zzkMRT3Qu8Cg5chRqYe82jPO1Yq2hlgzJez8IDlULVZX91jjKpEghhYid+yZ0h/D05ro1QqXfxiCSMvNO3WQ6XwagjrjNwwKxHTNuRxON9o565u0KFhPrmS5k8obTnvuK98RtCglvS7RPuVQ7Oz15+OOxn2HZcdLEWvk378Yzlep4+NnYqx/sw0V/Tm79GGs5tMLBOyXhnmEf/XoJVSnUzAepVKnY+pLN0+Sz6fqAOkviYxLKpE9OT47NYiGg+IWJTF1fBvwQ+jidQZUDSF5lp4akx2C0tSXgWCQ9nC/VuKqbaC7TmbfmAG/O594J1i1jsO39yEZJW1yM+Gx49WB9N2FQsSjgcCjGPoF5R7spNIff3ouF8NyE/05GlzSBaKPqAOy6ER65fscunB7DtO4NsEkr19K/31Q3hWco7WTiXbHeOR140bmkfnzHQr9zFRN79yIqE+5e5wy7exmhQ2aNRanesoZLwA3EN7WxcaSX4z1Xr1F7x9p1oltq3VRVaPgdq4LQtq/cVMF7rvUcoNXOW8KVvpD5pSq4jXVvf4ltiIXVvvsFw2YZ7hJwWwc36qgRNtRFjBJjSzhPOcuVC7ZgicnjPy7qNXAf0u939anvqlPfuVOJUy6yuPZm4/CJMYmS6cbp3JcYUz/K55Ehw2qkLCxjzzjYgiYvRNyre1AnairLpOCsYMx1HyeVsRv2peCqWTTdzZa6H4sgFnMpZBZZ6ZILqulPv6X0e3COAkgWYMdYPHtxdDw4f3Z08OhxaNdQfq9kNA+IL0NTmYnKXYDU3A9C3RhdMvCqR6OLZUgiq6z8xDBbqHskff2BJTbjtjQF0MOW+jh74zOoF0GAueoi5sLvetyrSoqYdKmzc5v82Og8f4wgCQEQWMmRY8eSpy6en4uIcs2pS0LbJFL99eHCXVGlvpnFp+q6u7YFqat+q/4OBfpGPe10+kNAr/da+SSbUbbHFnmwt/dndhI0e1ffEPmwtkJluk1j6dYJqqd8Pf++HsS2rsPRlp5DZw+1WcxQere0Xolbbwt8f86h0KcMiNpw7U7EZqmj47u9wdYmd3hjcL8W/SqI5eMP3OzFIb23bVzIiJtdsY8/rasD2JaGEwPzPbyzQQ5Pbk/WbzI2WoEBrmsgUgih4nm9unawinkdIl2FS61LG0GGTOqHNHvu19r5c/svx/fovew6IruOyK4jsuuI7Doiu47IriOy64jsOiK7jkiVsqJwbzVDli7j/6jeRpXHBea6+GToRXxUJvJ97Y5wI2Xa1eHoqA9cswL5WQTCc8G3dXS44VVT6erkvrCGAxESVUYhTCDZ4VfHzTlQ8ke3LlpJ4of1LgiTujS+uya5OObLZNsUPW5qAafX43/iz+DFi8HJycV8frhYHFr705jfsMpiS57rQl9TEHxBpPOK2cHewePB3pPB3hcX+3uH+/uH+wc/9bZ1WILg5LRQ7l12APl7Gixn3wMjfyMGLKQFDz+wadI8WuW5yY9RGhGd9HzSOK2jedFO/evdtTA53+KbKBXfgOCqA3yHAtSs/prelqdZWYjqhiCxY5MhtLC6LBckTIlCbV98Mt2sIP+aQgamao1gdoFwh9P7tGBNY2stuc+9UT6gvssT5O8TW+oZLNbuxobLHs27o5UTc5dlPeKtqo57CK2bCr7Eg/5qdujrCrL/F1aQ1ym1jU2uf+NUYp01D//CrHmlrClzeENSnqkpU397p9VLm0uOrEGd2QZInanwTsXpCetoMx5DGX0euqmKj/7SvuoU5+UpamLvo/iYNR65jKXMdbHk/vURX9PE41u6bPw132E9gkLzCFEtZ3R1umonYwgYzA1duQZK3Oim1b3GRVAvqdFtdQt6xX1tQqrrHvaJWhiPM9aV1FCs2n8x5gYy00PX9Rtq03Er+hxYgmvbYFg3vQ7mbc2Kc9IIJ8jAkDqddgNbLkIeeeMPvfm1Znu4o1vf/q06udU7JE70WnCqHC/cWkNBMNU3dFOeQ4TDUYzFJ7AslykWudQJ84DeSH3aF2o4G66BPRR+45d0Z5XYQbeCvxpz5tQU/W3PXWb+hjMb0PHdm4tN2hoXnaGZ1gb0HCSPM+VNLSRExUE2Q04QeUOvMjGSG2cxZLCv6lugT4NJtN7FNPvQd3eN15rGXW3ergbu9i7ktpbc2219rTsaA2+3V3gfVQc1i6BwNbcuWWp/05nD+3d8pPtTEzyrjNizwoXqhHvYWWby4u+1ZVXGob+th9om2bTmNb2qNolP/vvv/3zqPmU5v1YgY+7KzdBQ4t5O60udkH7DN19pvix+6lt/ViXTgTVYrVBJ+VcuxbLv9xODRC0Q+kZBxO0OIx1mDTIgkRnUBiqapyYxM029d5UCAFmf5NeTCbKphLvg5JH5k4kJrLNwl/WpxwqzouX0ajvR1DZxpsPk5WpGFSDose4mJ33HQz4kBjqEJ7LM1F2/heoqKCaJI/gjmD/cwcFwb4Pn19fXQ8nTQ0Tgkd9rR89Pj5/+cP50QHtW9buJWg7kxWITlYvQkwBocuVOXqhaHg4fDPktW2ZsAewa+Lgr0CF4rzuRRqjefRW2+yrsj/gqzMcQ6nKMQCOC9sobwq1PVX7uXR24OIBkBQ+1bh7Wn23BDc+hzLT69nYirUJ8Wa1oGAqYc8IEI5A5ew6X06y72a2a/skrn3Z+Ku7xCVonQSE3SSkx4UwCv/B4yU69JmNFAcBH3A9Dcvel2e5Ls92XZrsvzf6PX5p1ejrn0Ta+N6t8HlWDbo2/4DHwt6zCio0Mv95xxGJ879pmvQstxNqJ/x5twcV+L5fXdO8M/x72fsFffqXDyRs3GGj8tpcgXS1ROWCNA0s5tfS1Vl1nXnKd6R/IXXe6+fWS09FC/xJlnVu+JBOGkXxVLXczWzdURZpbTaKgVyr/A042zB8=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztV8tu4zYU/RWCm84AtuxJ0o0xGDRx0sLttB2ME3SRBggtXcuc0KRKUnZcw7t+ST+tX9J7SVmSZafoY9FFCwOGxMfhfZx7eLXlGbjUysJLo/mIjy0ID45dCQdsbPRc5qUVNOmYBYVzGfOGCXYtvGDfCvsEvlAihYT3uIWfSnD+ymQbPtry1GgP2tOjKAol04Az+OTopC136QKWgp4KawqwXoKjN5nR/6FZk2uE95sC8Nl5K3XOdz0+QyPvrDpefvfxPTNz5hdwZOdnji3BiwyHT0GmSqLJkxMmjMMMm1y/hPwy3BRSC/5FyDj952F3MdLSApp5T/FqQtHyoHP6Q41jZp8g9YgTkVyByY2hPxsOj63sGnSSG2ngTTj072WdHDjE/J8Z/x4zDnFO5OYhkGcBIgMbcjOOae/fBqR2nivsQIAeh2exLBQNHLEDATtRaGGyeBYP514M3/wlgWk7A9YaOzYZhS88X7fOPApFr0PBZnfjmUQrcjSt5dzFcLg7Ad/sqTLWjseVyJjURelZIaxAKkZvd0dhudOi9Atj5c+h4Jok0NLPYwn/R0MzwfOsFoo5sCuwLBzTiRFucpCWVnq8pe63/LKQ3wA9Pux6W34FwoK9xACHEfJa5I6ic0L2KChozcJg+HhhXAiKoK18sDofpGHxgBSl7wqs2AFVUj89xCBzyFgXrOloLyxN5QuuK0nR+ML7wo0Ggwzn+qKQicyt0D6RhpMDhwBTtB6j+RKGi9NdmIcmRFNiSkzwPlB1pkQc6GGaCTMWaI9rzBC+X1YkDW7ybqYuP0zYE2wYURmJWhE0YbcodCuhStir3uMBzmOlA2xZOs9mwAoLc/mMXcla+gUuDiaxR/ZKGw8BwFshVYgBpeB1j0GSJx3YEas2vt2Y0lI4+mjcu8eERKlNCbyowtuXxi4Flhf/+ofbY9/SFJzDPukJNDLWub15EamyGRnNDoxgdQRDeVIM42GN0FPegjxTIX9s2q2bfanES7KpofoibIaai6w7tr+NWteU1HOz1xORBj1B4ZABsCwKY/0XDW/q1MuvmqFDwrW52olavYm9+u2XX18z6bDNnK4hk27BqIYYPKcLoXNgQmcM6SznFW0CvWVKbDAriTFM2MSzErsanFHzvjO4GmSuGU4i2fymV+0XMwXUvIRhoVwPz8xkLj1qyFoohbcvHeaMkhkrDDa/kC60USZH1UMqaQQgbgmmYc0UrEARcUn3gjiKGXLPbwIIUt0gaWh5ajBdUmg0ORAjuGchL1XVTyE3BJuXSlGFZGgO2bkUWqNvGFQUdMCmjdKxrzYkN5L9LBkexXy9XiciTCfG5oNqrxu8n4xvvpve9GkPZgPDog6Sx6hGM5OWSwzOvopJqGK+zoZnF8l58ob2kvahdS174ofEqV6xWy6ty+qffX5UNeLh2Q9wUIaOooxdYFTle746jy0qApMdtTJXpdLVZhTCBck67txuq1ra7WgYS8+GSwNDImzgUbxC9jpIYv5EcnnYGtFyVLfT/c9+BwlI4f9wbfvm+fD9lERoVn13LcMdzK1Y0zcZ/o/4j/jDF1PUnXUY33KF9VSKvG7QwvUoKqlrZP4pyHz1QJ7tp/SmZWVX8aMz9E+undzyljiGwvuuXh5nXtxQa2RcTUmmXvR3eWgi7A==
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: eJztW+ty28YVfpUt/kjOkBSpmx1Nmqks2Y0ST6QRpXqmlme8BJbkRiCA7gKkGQ3/9Un6aH2SfmcXd4AmGcdtZ+I/Ngnuntuey3fOQk+OJ7SrZBTLMHDOnAsleCw04+ySx/hHatcPdaIEO58oIWYiiNmdmEU+VvWcjqPEPxKh45eht3TOnhw3DGIsoY88inzpcqJ78Ism4k+OdqdixulTpMJIqFgKTd888CpY5ZwyRmZJRcxbsJVKeGwshe9pFofMNZJvJTjkjpcRyDrh6BfhxvRdxj49uNwgidWYWDtn7xyfB5OET+gxqXAB7VXo+0LhAc/23gglQy9dMpxyJYPJLWympEvaaPzihp64HmO7lxhpaGXO+8qrP7kVc6mxdf0vP3A9xW+REhpPzSFcirEMZJxt42A+F877Tu0ocpXwOTUSiRpMiFXlDK6G1+z06NvugGV7GOnB9kVv0mN7IthjoWJ7er73DHvFRw4TEjkROKuGvQpu+ZFUuZ0HoDbhgdRGG7AKNA4tieEEnPzVFxPu+0vmkZ54CL1lvGQyYDxYsl8SJbVnLV47RE+SPQI+o2M0VIyBEuXjX4kjgf7LIWQKVdNcUTKCl/8klpvtZfzSzVVmdit7xN5Vyr+Fxox/fCOCSTx1zk76m0gaIqtCi51lMhuZ9Mh4CC1FxMgQLYTGoZpxRDp+lxvp3t++IVI1a36uuhk5pi291WrVjLuCiURumpjYnCESZsnMORs0WSw1g2psMZXulMVTZJQ8f0jN5tw37pK789HpyWp9aG906/JqBreehgvDlAgSPw2iwuux65fDP7FrQwPPwsT32EiwvTV89x7qTh6F8LXlvfHpWiwQjVtBaRvf82Q1EeFE8QhWKBHGcw1DI9TfhDa1t0REzmlXp3k7FUjXSOUIYM9YwdIiz6nIvNGtfyytxkkasplRtTUXU2XLU7FaZmmpbozdPOgHnOCMUo5HrpSzdXlAJ/Yoopj4tJt3o2Jvq7qkRK2TwHJEuX5Au9IkpwMJuI0JpyhRUag3paZBvxGseYmWY2aLzZ9jlYgOSwJfaM3S2sS4j8LtLdlYhTMrheLjmM2FokLmFCJclslvyBxfUBqfL8aJ/5JrqdvEEAF5xTuDhBQ4UYB8KVGqsGHXcENONriJanY4prxqyKya8GMzFLgkCiQjqATIUdDOJOucSoNsCcP8DuRZRm4tH4OINnKiVTvxWouwfpNSNyVqrCBHjFK8VpAdhaEveNCge0OwAlrI2Ux4EpgVmAieRi5GEb2qgZ8NePd9HSpnJHSEvGkz/mG/30Tom1F4itg9g3+/VNuwAVSyOBMmTGIfuBGlIChV/JGIF0IEWVcxDBPlAhGgPNkH95pKyVCouXQph/I4z8lyQih0tGSjMJ72GgXZqPyRRDJ4wsjZKTcUWZzjt1RGA0uzL3/Lf/6sziNL761Ztprs0sCKsX0E2P1/1rdk9izOnCvFl2RfmKwlVa8azkDrKSbvb680/f/j8Prn7ptLlpLWBsFuEdn3gURTvEUfWgPaluoO8ucg9N26vrVZfe6mn5KMWNiCk9lz1flCLeGqcPGNdEnodLFNmgApW7T5q0rsfJFzY/segmxOkwiy2p70rGr1MP1CKtbZpxSsDF9b7K8t9v+sxf5kW93SUn9tor820X/EJroO3s3CrDNYWwC2b4trcVh824rHZze7bwwBNiIKJgFsZFkDmZvx0JqkYJjwnJBJahylSkfCReK1B2twHmCUG6OsLQi+S1qJ1Ef9GF1wfOwGYdyVQZfkghrgOOa+FtXMkJa2sgSNmG6HjnkwV2bkpyfHzweHh4fihfvcPRqNjtxD98VJf7BBS3Z1+alC187r56bs9mHmITn5jjlBCVTAA7Q7D4bRg0OY7gFFAR8bqHpbIV4nvm9qa8YU2UvOpZdwfxsnzkU0wSsCjYZhDmzS2i+3SpAeapXTsKBEnLyKsc0EBhhsEqpWaNKuKNIhutoWrS5SUu2MtBtGO5wpTY4aHIZEg6n86gzHVmdkstXGsdLXOdLvPkfaeryDQgOiG/IoZbHIzoHAFueMHPZfnVbB0YLzSA7LuXZzyr6mXTdX1RRdqVO5hh3bhBAG4XMufT7yof/NlS0yzdmMdtK5VWryFlmyK+D8WJrTom8mIgCccb9hGSE2g9v7wBBRjBOwUEVjCTCthonSwZYpMwRn7CRrD+gAskFiFS567I56PWn2ojwlFp8iogbPmKuWUZyBHDNT4sTHTKAOnzGeeDB5MOk9BA/BuUZTUUyLHxyduFBchwopGjUtmQUdNHG55AUCpkYPeykp+KH7uEvhM42d1SqtI9aepr+zH+kwaBGs8ivM8qvwhgGPwD1On9qH6egnljNgOeSx37+Anp62FNDstNPSWVJla16VPNGEdGTwMNEAGA8peZwH0q2FQ8KdBvB0H+fCNQGS0rGg2caRPJSEenBKqKvONwX6jcTlhspz3q9KR/N5OOT428PW8cXNT1mshqkPE6BacF2KCGdVcYutBXnq9XqrVq5lXrLOyk5h38oYRo2vm+r/FlBwBWTimpdkDM/MqEZRX4xjNvJ58EhTkRaXp0YqoJN1E59T6LJqBPQKejO+pGyg6Q2bgPApXGIsjUvIoGeBTjOkPtOiWTiAicEG+9oOf2gW+sxOgagl7LFzavbMY3bBg9D4MIQxGXtI/ipoNaKXXb26e81uX1+wF89fnPQYu4ozLA5qQH3kMOlrPKn7WH8HLnfR6MEGNotdeZ2ascrfMwPQpH3VyCtbW4UPRofukXcsTsann/q8tuK3nfn+8Ifz7sDOBfP0trVIh/3D425/0B2c3A36Z0f9s37/781IyOiSDMbHsjxPPjZFa47K5fXI+EWCoXHtCyRFdn93QceNBlba6RZPEDGKlHi5vMqRuA2dZjTYXymDdmo61UhdE3TZKf8cnxwP+KE4Fc9PTr/t9/uD4xM+6vdb/HaM+kVdCQonXeF4MwRgog1SQpRO4YzpfZOdraoS+MoLpRXtY3f82DV1vYoGNiCkcZUwJaMgREENJilco4GtjvMFHXwa008hk0AIuRApUPOE/bqb/27nve5R04FAQaguMIzUsbl+Rt0dA5ZaRBGlVQwyUznpIIQjmY2da8FWlX+YgZbtlSiLiiz1mbKy/YVgXhjsxewxCBfmMpTGYrVVpk7ZSzsLmJ+l7VAdJ+5yfVpCnO8NsSkaM3SAZIsLiw27d+m1T3HLmXI015+V5FS/G23cYZVpMsvLAt9jQJ9d3s8sKymUCtUF4oGEoc+X1TFH3UBV1FbsbhsB5sod9/urFvJtQ6fcHi85lcIIUCriCugottquGma5D4os5JQPgZae2OvrP6hprsBPBcjeCOI5spFhU7ORqaduosxA5d2Tg87OXMe8A6h8cl4KroQ6T+hCAU9Iaz7R2aVka3+qyTYQakqDYeBWbWzDiYJzMD86wFmM5eSAoqvr5fu7vAR2rbjayFMfD83CVJv0junMmcZxpM8ODjz81uWR7En0VEHckzTtrRMYQv4UmbXR0PbnOpn3hZEs/jFHnJmqmGLaB3RRQzRtiGYjO+c8dVOeXStUG1D0xo9iyciZabhuXZQaSEG3KEk+PPtQofMhzQRslmh6pYFS31h+RKJbABhjsRGJfWD7yHp2iB0r9NTGBhF3xbMOMxe4VbJnLN343TJMFJmjC+G+/2CgadkpnpyR+fY6S/Y/vr1r6maqH4rhI7BLxLXOxLOUUpkJVVeEYLkFTYCaEmg2FPWazs0hH6ZQvi3eV3+VBctWL5IUl+D0AnPb5WrpnrKIyPRc8+/5tWHxyHpX/rV+gVeGUvV7t6PTk09em5WukQoG1VugEpxpu7Xpr71lKTY2LktKIuc3H8XytnuLkoHKNw7FxUJjKlmVuzJlXPNTeVK4YYnFXCWR187NijXZBI9etFqZi9hxmNUVbueoKCDSHEUSRaGK/1Jkj9xR5F+LR9W0U85YtdjJN7H9f//zX88IeXI2XAiP3gMzbRxaqSkc2A6OkNSK6ZpO311CZZrTDMi0CMDN1En7464OsVoAFqU31vGyk+43EzeXcB4eo0/umNZwImPUkgVNLmLDTMMFPRaFnh11hH44QfVDQglAwIzvWCAWaJznwqf0RfXPFEk+QgaKl4YIEl44s+2yGyImpbl/MOnBqKfExLTTND+htxEYXMhf2vGYkXPGgwC6kX9B2cBexWU5FykOKe+w12/YfLFY9Lj5uReqyUG6Vx+8ubp49fPwVZf2rIrJYXEOlKm90E1mmdc4pbddTEfXO+oNTICg+EG6kjz2T3C2+zOW2l1LjmF2/jueNFfSKz8HeCiD0msJtjC/c+ZHJgypNKeB016cUQmnVNKx5emJJodIQKsVPUbuVQY3wBpIWHQ0FkVkhZCq+aPJoBV0TMtR3tohcLaDKkgUf3JtGXXcXA+pCo3Sv1yaGRjmKL4g0I5/z5wHx4zbwijPp+Z5pRZYuqu0z63W+UdT59MPpFn2U7AsSVkv+VYZ+8rKmi3fkXuh0HyfL7e/rN2QF0m7mk6X2pH/AGUO7KU=
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."
sidebar_label: "Create OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV9uO2zYQ/RWCTwlgy85u+rIIgu6tgXtJgq6DPmwXWFoay8zSpEpS9jqG3/ol/bR+SWdI2pJsb5Ft+1YYMCSSM5zLmTOjNS/A5VZWXhrNz/ilBeHBMaHZh/Paz07YpZKgPZsay2oHbCn9jAl2JbxgPwn7AL5SIoeM97iF32pw/sIUK3625rnRHiXpUVSVkrmgOwafHV205i6fwVzQU2VNBdZLcEEs3PdezIHe9qyLttAmM1PmZ9C1Eo3wqwoFufNW6pJveknfVVvPE2pbZ75S+yY6LS0U/Oy2bfrd7qyZfIbc49l42lVGu+jpyXB4aMt+YJkFhRkp9tKRhzwVaNI/DLMRpC45hu9da3tHkzIqDu0dXT0zEzeAtvtDRXH9mcqOw+S/xsfzgdHjpRXaj3HVHep7R3ssbDKhlFlieqm+vkqxl3MsMjGvDvWOt1tHrYyYCT5YpoTzbG4KOU2Aaa6S2j+B7FHAWzuLnTx0nG4bekfq9gGG6mWd1HfAeBcqZQaiABuCdxkR3h8HDW1IJ50B6z0Oj3iZooWDQkCFeyXf0sniXTzc+3r46lnk1Y4SWGvspSkoFOG5jaoDRtivsUa68QxzASWa1nLu9XC4OaK+kUlQacfjQhRM6qr2rBIWU+Wjt5uDsHzSlAlj5ZfALU0S6Og3ka/+p6EZ4X1WC8Uc2AVYFq7ZixEKOchrKz12wNs1vwBhwVIR4uvdhvwUpaN4XAjspQjCqSxrGwLoKAx4/8xgwHhlXAiDIFE+WJwO8nB4UGB/6LsKO8MgVk0/31JFNMyFm/cJbG6S3XiutgrXZt5X7mwwKHCvLyqZyVC9mTRYLQfkjHZj5J7S4eL2vpq7Jhw3hIqYzPNK/gCrVlZEXOhhSklnLMYe14Hb+XkC5JaluoadfxyxB1gxCgVGIYExY2Nkv4VQ9a4P3Hf03KeaZ/MaeXACrLIwlY/Iw2G+uY82snv2QhsPQYG3QqoQAwr+yx6DrMz21J6xJPhmZWpL4eijcW/vMyKgNhjWfBLevjN2LrCU+Pe/jA99y3NwjnnzABrR6dzWvKgp2YzoZR0j2C6CoRQphvGyhuIpb4HjqWh/bsa2621ZdMewpm6ONMtWa5J6arYMIfLAEEgFkpDi6qoy1n/boGOXYPmuWerCqo3IvdjshNiLP3//4yWT2EnZDTZS6WaMaoTBYz4TugQcZQuGoN11ugBimVPOzUJipDI28jTbOtxR074zeBpkqRluIqT8qpfkxUQBddGwLJTr4Z2FLKVHVlhiI8fxhS5zRsmCVaZgHvKZNsqUyGMIGI0KCEGCaVgyBQtQBE9iskB3YoII86ugBAFtEBp0PDeYFCl0nqbv4J6FslaROAgBgk1rpagOCjSH7JwLrdE3DCpSNODMSenY1hRCGCF9kg0PYr5cLjMRtjNjy0GSdYMfR5fX72+u+yQTphCvOsljVImFyes5Bmdbq0RHMV8nw5PX2Wn2imSJ29C6lj3xqyONK9mwmX6KLo3vWs+/+k5JReDh0Q9wUYbxIERhnQj3li9O42iNlEtm7EgXX7q0ixw3I65GmfV6gqz+yarNhpaxqiy1AXxcCBvAE7rAtmUEnn4gJuxOOHQciev4GLOVIG6o/N+ebbeTjx9uiF8m6dNsHlopt2JJgxj+n/Ff8UfOVbEXUfum9TVXWES1KHdzVuhyIrFYCuWOX9IDebYld71qWfkmUdeYOO0tbkRvAsWhxaj7L0+dEqs=
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.

## 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: eJzlVsFuGzcQ/ZXBXpoA0kqx3YsRBLUlt1DrBkVto4fAgKnd0S5jimRIrmRV0K1fkk/Ll3SGu5JWKxkI0GMv9orkPM7Mm3mcdZKjz5y0QRqdXCZjVBjQw7XwCCOjZ7KonOBNDw6VCJhDMCBgLIKA34V7xmCVyDBNeolDb+kg+uRynZwNh/yvA9+xOnlPHn0gvMzogDowjLBWySweGHz2jLVOfFbiXPCXdcaiC7K+eUqYh5DHZ2R+7NxkTHeGlUX69sFJXSSbXkR7cOr4+MOft2BmEEo8SsYPHuYYRE7LpyAzJSmsyQkXRnEHJuPXkF+Hu8PMYXgVst7+ftgN0/mlkg7JzU+cr30qWhF0bn/c4ZjpZ8zCEc4Jbh43fKhEkaOL3Ixq2vv3EanNc4MdC6CX4IuYW8ULR9VBgJ0stDChviuJ914M3zHyd5daOxh0zriRyTl98XvcuvMoFb1OCe6t95FJ8qIg11rBXQyHmxPwe5uGsXY+rkUOUtsqgBVOUCnW0W6O0vKgRRVK4+TfyFzuSeCjP9Yd/D9NzYTuc1oo8OgW6CBe08kRGXnMKifDioJeJ1dW/ob8+bjprZNrFA7dFSU4rnDUovCcnROqx0khb0pD6Ut2CmgFGyeDxfkgi8cHrCl9b6lnB9xL/ewQhR1id330p6vtc9NEQ+cq1rSkDMH6y8Egp72+sDKVhRM6pNIkHMIhwB35T/l8DcPX212Yx32S7rhWaoq3qdpxJeqFHhHNmHWL9hJNHNHvq6ZMY5hJl6urPybwjCvgYqZSbUo0hXuSuoVQFW517+kA56lRAphXPsAUwTqcyRd64pYylHQ4ugRP8EabgBEgOCFVzAFT8LYHmBZpB/YSGsP3K1M5TkefnPvwlLIstYuCnqr462fj5oIaLPn1r/vj2LIMvadH9xk11az3W/dqpMZnqmk4cAJ2GYwNyjmsL9tLPfMWBVrqmdl2uship1NLS+bWV9YaF37a87mjRP6yXzoshHYNdaLZGcGbb/98fQvS0yxxt8Rc+hK4tgFfslLoAkHoHKjM5KyhM5adzJgls5AUWwqTABWNG7SjZn1v6DTKQgNtUhGEVa+xF1OFQO9TXBbK9+jOXBYyUHcvhaJei5d5o2QO1tCEg1mpjTIF6RFRrAmAORegcQkKF6i4oFiRomyJKdVEWEUQKkFDZPLxzJDmSKHJ5UhYDM9hUalm0CHOBMwqpbhyc3KH/ZwLrSk2SipJLdI0xXRsu4CKjorwLB0e5Xy5XKYibqfGFYPG1g9uJ6Obj3c3fbYhNigt6oA84N7JTVbNKTnb7mIBqfk6G55dpOfpO7a1xgfyruVPPS2eGuK6Zdx6Rv7bjNnUbsCXMKBFGd/6qp7ParX8lCzO6+GRgNmPnWI2I0xXM0mgSgqNLdfrZsbZbHj5S4UuyjmlRLhYR7W4b/WJRfaZZSy2qeWXLOrNyZmkrfDjm9ub+xs6Lhol2Kvgc1TB5oMv2G7pVQu+K4i1F/yXdfukyXummnTpw+54vfOqwU5C6tOcax7W/gU9IT+U
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: eJzlWN1u2zgWfhVCN5MMbPknTpoJBoNNk3THM4O2SFIMsE2A0hJlcyKTGpKK4zF8t0+yj7ZPst+hJFuW3K2LXk4vUlkiD8/Pd75zDldBLGxkZOakVsFFcC1S4YRlnF1zhz/SRqm2uRHscmqEmAvl2L2YZyl3Igw6QcYNn2OHscHFx1Wg8ANSYuzdbt3srDaOY+yUdFzG3QzPuzp8UPLPXLDxNdPJHkUqKdhnxJ+5NCIOLpzJRSew0UzMeXCxCtwyI0WsM1JNg/X6kRbbTCsrLH0f9vv0X8P4L5rMCv+Q/pFWDp9ICs+yVEacpPT+sCRqVVMlMzoTxsniYCOepZXFmlJJPflDRA4inXQpvbit1jQ9c8m+nwoljIy+Z5UgNtexSFnEMwedLXMzwSyW8FRaEbNSTet9qZas0Os7yywckwpm9CJk9zNpmfR7FbO514c5zQbHLDLLzOmp4dlMRtg0VZzOgayYDY8Zz2PpICl8UA/q0spYsMToudfiIbB5FAlrtXkIoEiaz1UHAd1obmc6T2M2EaQl7UUoWaqjJxETtl66SruuVF2C04RbuCbhqRX1uH8MJAWjsOotoa9T+tODrHikuNIieOUvuOUvEd8pnuF0V74tXv7M7cxHYS6s4/MsAGh2g4ezWtjqBIk2cw4gBHgWL9jog3h2Ono1GA6H4jx6FZ1MJifRMDo76w9aQa2iDcAH6x1TDj6LHLQBa+uA9+Rwndt0SSHx4hGPSe4YpDEnopkCelPEhQO8th4WnqYIyUNNqQd/ssrn5PvmuZlGHixJgfqHWxFpEweP61povsmN56Mfhi0r74G4978SzAl7usTwjDu24LaWEcF6BxYHK7IKw3C999T6WbJ5FGWMiH+XDk5179rmT7ROBVefO7YE/O6hYxUT3fhkx5mVU72hqUgcm6RcPTGp2B7IswUlOSIb5WA0WMx2MyDcypvzJbGBRbYhjIAPIJFIDwmpQm/dnpT6Ro9W6YBDCEXsiFgMhv1y9+7tMT1wButdyC7Bukv/ml1xpT2GoQyJYXeEV0Grkb1sfHP/ht2+uWLnr85PQ8bGztMilwA7EO4Bk0iRxraCT4F3Jl4ikTn4oGCxcdxpOKv+u3IAqLByTY1XDvYKH0yG0Uk8EqfJ2f97bjmOjiH998X86O7ny+7gmPTa0tvBKg37w1G3P+gOTu8H/YuT/kW//692JlRySQePsYrnCWMz1EhUrjgk528JZnz3jp2DFNmH+ysKt2CkHqnJc2SMISNeLwnvzzLOeVqkTjsbiq/EoJ1m6d8V9Q7RNV/FP6PT0YAPxZl4dXr2Q7/fH4xO+QTdQxu3CeqXigQVTq4Yj+dIwBzRKLJ0BjBGoFh0D3gBnth0AgSWqlAWqr10k6eur+u73UBT5YYjkl3BREZKo6CqqVdCMGphrNss6OApoU+aSXQIGyVIowzlVRQ/vw6/h6E3OmkDCBKE6aKHkZZaFsZRdxMOZvUdRVZWMehM5aSDFM4kfOk/NpJtV/+7qmk53Ii6qmCpb9SVHS0Ei7X6zrEnpRdMFiTTXOXrlC8XDHUZvQ/yFf86rT6x3v5sUPTol84Ej30zvgquis6ve+93r9rNsW9Vd6in2ceum3bXZbLirMCfO0JjA8kHN8V1E4Qx2lwB7aQMPV/Xznxsm7/bk213by2T0AKYrxs36vfXe8TvQcTWH685FboMjdJmzPERabnlg9pyTFAPQuGa0d/YNbfC6tyAFYFn9Ju5ajvotJjF/qYOGuM8o1C8wGHPIGN/TMNHvp2IciPd0o/Zl5n8VdAjeupV8FpwI8wlEOjfkNV8SvP45wdaS76BUjMd0/jgh1o/zZOMoPd80kM0EjntUQvWjTcSuryS0Ft9cchfF9PVc3U50LxpmOvSZqzLDZW6mXOZvej1Ynzr8kyGEoOncqHUARm6K+AOVpbt6z4ZtvjcFPO4dWXRJHogVA7dRJQXL8pripLpOtX9xmWZ7R6h7Sn9/Zg9iSUjToBDSiDTlC3YM09zUXWZn3bkfCoJlc1z1OiJrw+JfEE1WGB6wGKvEvvEjpBKwgtwhsvU+yDjkTjuMBFOw4bYC1Zu/HGJRCR3dKHcT598/16HziqY+F9vqor4y+/3bdt8i4CO4QkNXsatrdQrJJU60+ixowTbeNCnse8T/IZtU0NxCwjpUiW64gNUVJ+nc9hJeZZnmTbuH9t4bkIi/7l9tQuEOoYa1mw2saP//vs/x9QwcXa3EAD8rJg+MAHMOPonf98BmMmkDKeHnYwoSvqZri58Z4t2jwbANOlajdUC1ZzhI0Dglp1yP5+kgjpB/xrjXcdPNFPpwAELGridP8xilo5ZpuNiQtepnoK1EGIFARRzzpRYYN57FikBinjLkxufABNu6YUAgnpeTHmRRl5KTg2qD5g3z4ipnwJp7EfMOEvyNF0WtzpezzlXCrbBqSBkoaxnyioLADqAcBj2Wz5fLBYh959Dbaa9cq/t/Ta+unl7d9OlPevthdc2DpQ7sY5yYpIqu4hAinjRIBKehAPf4GnroF1Nn+Ju7oCLyyaqa7Xnqy9AS/Q68eJ6eCl90+SdsSrp9GPwfFLcF4JQy7uRvZSKbxdfvjkFgc1gOsldrehW7INJ12t6jSnd+KIAl3HjcVbwrrT0HO+/Tagbf3RbltZjdvgl7F4PVDSqiEM96RUt9hOx7AH3w+vHTTPrbSj2Eftkriax3bHW69r1zW839zdBMQHukvuTJ/fygQ7Yq3CT5wst6C+Vo71bfiQEg25/2iwvvnx2w4YZi9XkPmrl/wdsiSz7
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."
sidebar_label: "Delete OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u20YQfpUBTzYgUYrtXoQgqGO7gds0LWIFPRgCvCJH5MarXWZ3KVkVdOuT9NH6JJ1ZUhQpOoXTa07i/n3z/81oG6XoEisLL42OJtE1KvToQMC18AJ+FfYRfaFEgmBRCY8p/HZZ+vwMrpRE7eNoEBXCiiW9si6a3G8jTQtCSsL5bUoXJCMXwuf0bfFLKS2m0cTbEgeRS3Jcimiyjfym4HfOW6mzaLeb8WVXGO3Q8fnZeMw/R/q+SEtIg1msS2K0px1GEkWhZCIYafTZMdy2pU5hTYHWy0q4EQxXobWUNfPPmHj2Qed2Y3tP39trMAvwOXYVJIQj8wc1yB0mFn0fqNr/RrAPITTHULz7jUDXbYBeTA6rF8NmVmg/pV3Xx3vHZxAOQShl1hTehbEvA/Zyic6LZdHHne6PntUSyL+issGCEs7D0qRyUSfMQZQkubtdO7Hv27nfiWInDh2j24rOGO44wQheljV8JxnpNl3PUaShALfRVZXhw2lA2PYrLOT6IMInEqZ4o1cIBNh1VRsTKllRkHsxfhUS/qVV1fYSWmvslUnZFeG7nVWzvgu6NXZ4fbCMYoEZqdYy7mI83j0D3+Obtj/eihSkLkoPDbWxtbueWz5pjoSx8s/ALYcgVK65+I5d8xGdKS0RsjaeqrXUfQf9UBH6d+qgW5JntVDg0K7QQhBz5CN65DAprfSb0FrforBomaVoOeMO6UXGXZfEOgSq0oXMShsc6NgNJD835LCoaoChWfPjaLQ6HyXh+iilFjp0BTXPUUUsw4qkRts9je0i1oO1rDr8Md0vTW0E3Sutor3c+8JNRqOUzoaikLEMXBdLQ9zSa2VkBLnxaxiuOj6GmR18c8cpUkX2spC/4KYVIlFt1ENITV2D/ZByWZfvntO7il3+fguPuAH2CjmizswYptQrVkKVTdd86OA81AwJy5K6xhyhsLiQT9S11tLndDmoBA9wQrWBAcBbIVXwAcfhdAAYZ/ER7ATqh683VFnsjiEp9+YhZrpuZ8Y2mofVT8YuBdVV9PMf075tSYLOgTePqClVndurVyHVOlMqQ0cJaDwY6pJ9WAk7NESOW+iIUi/MvsBFEgqcKllybF1ZFMb6Hw/xbEIi3x22uonQzqEja5pHcPLPX3+fguQJ9o4GBely4AQHfEpyoTMEoVOgNGs6eUg7mXCUzEqSbTHceihp6KQTtRg6Q7dRZhrokJLAbwb1ezFXyFNC2BbKDUhmKjPpqajXNKjQeMbCnFEyhcKk4DHJtVEmIxqiEGsC4JgL0LgGhStUnFBMRIGtxJxywm8CCKWgoWDy9cQQ1UihSeUQsGCexaxUVd1zzAQsSqU4c1NSh/VcCq3JNnIqMSzSTM3h2FcBJR0l4Vk87vl8vV7HIhzHxmaj+q0bvb+9uvlwdzPkN2HK8qoTPODaSU1SLsk5++piAqnidTY+u4jP41f8tjDOk3Ytfao/IfU4Fo8P013aZeGmc/yvvy11unp88iO6KsPYE6zf1ix5H63Oq78MxJMsvmFKWnS4ktaTZugjZsrJJn6/3c6JmD9Ztdvx9pcSLTM5fa6EDQlUEap0/E1EvaA8wv8w9ORj3QRP4Wsm7IlPM+sFmqIVfT4yLx5G092sGRuDDtUx00LhWw/7s2G7rVzfvL+Z3tB1UTNPLbzhhPqDBTyr1+uabqbMQ28aLQMtsYq73b/MihXz
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.

## 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: eJztVs1u2zgQfhVCpxawZdebvQRFsWnaLdIWaYGk6KEIIFoaS2xkUiWpOF7Dt32SfbR9kv2Gom1ZSbEo9lbsITFFcv6+Gc43m6SgxlIuPRXJ6ULWjkbYcrlVjVdGJ6fJdaWcIF00RmkvauW8E74i0ch1bWQhcqM94cSvG+IT6YUUK5pXxtyKXGrROkrFJ0fCaPwtWBgfd7JucV/poCyLWq6hJBMLRXUhVhVpsTatyC3BP2GsaJuCV3v9qbiGsCN7R1Y0ZuiadLj69urDpZibYi0W0JDJpqkV4kVwk6/O6CwVvw/378er1WqM68txa2vSuSmoyEZBdzS2lLfE2p23SpcxrINhXUR3lO+8YGWi1QVEQ7zxZiZuaZ2KS4OoeD+XjfKyFtl5tofm/ACNy4Ql1xgNAANIHQDGst7oQwQ2r6Qu8TsnvyIAmcu6dmkySkxDNoR5gYwnJfnPHZYfO4/61nB7Z84lp5tkNp3yT8wVL4do8p7LK1pKXjWWjXnVSR9pxvewzH6wpOAc3ctlU1Ny+uWhI6PkXzOa3IwS5Wn5iDdnj/oSbOp2+V8Msh4Y6Oom2e43pLVynWy3DPm3Vll+j1+OMTtIm/lXyj1ub4ev9cM7OFKRREFwWHzhZPrsh7LWt0/WGnsO3zlyXr/qWXvgz2iQ8YM0PuJVNBEqyfazdzKdbh9Rf5CJYPVEkpdIjdJN65EoK5fkoXK7fQSQT1q2vjJW/YGIhtD8+oMF/XNBcwF7VqPbxJ4WzAwwgpCjvLXKrxH0Jjlr1Dvi5c12tElekrRkzwBw2OGoZekYndhUGAh4UJnYaxgHybeTyd1sAtwXqpzEl+0m8c1NYj7GPjahzj8XHDgO4RUtTXQf9/DSsFd537jTyaTA2Rj9NFWlldqnyiTs87GCKzjMDfw7Olx3PFRzc0Dlioujy+kOm31yZLeBLsOmOljxpZEU7jGxLkOxJcPknH28YG4QXL3AItZk1+9Di9/1++xITyY6M2LZOo/mL8DuC3VPoFPlK1wOLolMPNE7zvFWqjpg0Micno4EpWU6UHsqouBzELJlOMZw7kWWcgfrV8EmmYcvcOpS4kUlbz9fP4wtz8mhsZtbEFMjndu512mKPjMBHjkh9giGF8kYdsaS/WvjvIUmqvTC7J62zMPTxhtWnFvXNo2x/rdDPvcpUW8OW8eF0K+hQTR7IfHk7z//eioU8/3VigrlKoF5RQq679g4zAUoM7WI6Qxlp3LOkrlTiC0VF57ZzeGkXoydwW1SpRY4RBH49SjKy3lNPBiFbYxtI9gsVBmGhxWonnww5kyteBQphKe80qY2JRoQUqyhgHMuhaaVqOmOai4obkGhT8k5asKvgxKUoEEy+Xpu0GSU1HA5JCyEZ6ls6xBPmOcw7LR1zZVbwB32cym1RmwAFb2VME1wOnavAEWHIpyl0weYg0FTGY5TY8tJlHWT9xfnry+vXo9ZhglU+fooeYLfTmHydglwdq+LG0iXr9l0dpL+kj5jWR7S4F3Pn/cYcAUAPMwb/WFkWMo97vh/UP7JBuXYUjzd+0lTS/TwbazQTSSxL8ndDBc7GsNiR2SB5YLb3WmPzMAcFeJl2c1mLh19svV2y9vfWrKBWFGr0oYH3tHsjjiY/W6ZX0L/bJhLQwiBaAZTy7bPu29ecwuWsT8fuOk2cFNcsPbdkV73dA9pqnOB/zObPirynB8g2OLF/np38l2BfWPvbjPUN5g9/gEY6iTB
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><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}>

Access token passed with Bearer prefix in Authorization header

<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 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: eJztW+ly2zgSfhUU/8SekmjJR5JxTU2t4yQTzZGkImenahNXApGQhDFFcAjQssalf/sk+2j7JNvdAG/KkpPd2dpa/7F5AI1Gn1+DrVsvFDpIZWKkir1T72epjWY8ithzbjh7LnUQKZ2lgp3NUiEWIjbsnQhUGmo2VSkzc8FUOuOx1BxJ9FgoEhGHMp4xFTN6n6oIBk1bYwsCKRHssY9eCIt+0ipLA/HRg8Esf5ZpoPhJi/Ra4iv/Y+z1vISnfCGMSLV3+uG2sZPX2WIiUlw3dfwaxfSVTGjZhM9kTFz47IzFYgbX18gey+JU8JBPgOdrHmWCTUEamk14cIUUPg8++7C0xCV+z0S6gpsYuIBbNZ1qYeA+Fb9nMhWhdwpzteh5OpiLBfdObz2zSnCojI2YiRTGhmLKs8h4p4Oet5CxXGQLuF6ve7c52UgupGkuWd/rL/wGJ7K4a8+pMFkas0TQroX/pQwOa1xVFfkOFHw3gy9lBGpikxV7UzUAnFhYQdPg3m22im6jqG3MpFnXvrRJYY5X3YmWs3hsuMn0rntYzgUwbLnWNDM37+49MKmBZVwnZz+L3d2e8Gc+40FufWCUdL2/k5aK3VziaJ2oWAuN7w8HA/xX38A2j2bo/LBuoED5sUECPEkiGZCyDn7TSOW2wkWSKrAqI+2aqJKSekHcRYsK1zxNOYpXGrGoPleT30RgWnI/c8YM/xLYJJCEABVXuJ8IsxQiZtyKf0yGAkNCe/8erYSNrZVgROKGBUBgAsoDJYgQVTpRZt4DJ9dwC4aJuswS2BHc/gBhA6wpAC8SPruAN28S0x/FLjyEGIDAc4Wu2UVaaN4pF/lBERVrzznoFh20MJwapx1LATEVRyu8kyH5Te7mqDIO0QOm405oYxwZ1jZSlqb0wZMh6pjHKgbNRiO826C6C7FIIpDBO3EtNSrDjrQCHudLuKfEvOO9+k4lZoQzjVwIcJZFgs8qQYAY6Iom+rmIQLahB8ZdtzTYQcsHmlbzPpbgxluzGJMh3MipFKnvrety2boGKihIldb9Kv88qhBt5DhaY1dpd3iGkSbCB1WNNJzlm5mIRSqDb2BJO4gtVCgisLuELMKGLRgCVoTm7tydYhiPV8z69yPNUKERpu8l2iIYn6S5MdMZ8YO2O9wHCawSo2YpT+YyKC2PDP5wn/EslAYogSF+jM80iIZNU7UgLiAoZkEgtFYpxMJARdkCEAQvOddzlUUhugtwiXPRZSIVXIkQ89hNP1amL+M+ihSdtwiVLYO3u3qNIb/n5Gktjy7RTHAQSOUPEMsfIhzHPIHVjXtqH77iel4z5R1NE4xgwSGgYooSNzCRlPj45PjJ8PDwUDwNngRHk8lRcBg8fjwYtpSaa5uNnqP9VLay81oooMLSWgu8RYGrTENs+ejIgz4mmbHmK4I5+QTohUMS0FW1ADgClXysMEWJWMSIYz601k0U5JOVCxmNHOFdriuq+SoxPj3+9rDTXd/+VCBRZ8OYDpZcVzzCW9fMYmdGbn3fX3euWl1LNpeySehXaUCo5k17+xMFAZHHm5Z1Bl9fdAQIHNI2OTusmQuVNhqJKeTMiMdXgDZYh8ljHotRs0EG8QhzSt0D/JLegq8wGmjwNlAjmA+YxFSSSciYgl2XS32lRHN3EC6h7mEUg439OH7zeh8vOIPdGwD2gF5W9Jid53EdmCHoOUZ7FTgagfHoxcVL9u7lOXv65OmJz9jI5CnVFkNoMBDOo7BAetbembgJRGJABjaKjQCv1oVVvc8FgDl53YorO0uFDyeHwVF4LE6mj++6bgkOl0H+u3S+N3511h/uI19leNuZpcPB4XF/MOwPTy6Gg9Ojwelg8Le2J+R0kQeysTzOo43NAWtC5gp9FH4ZYEbjN+wpBEX2/uIc1S0Ysods8gw8JsVNPFuhvV/LMMvzdtsb7FuMoL0meq6TeoMQ7l7x5/jkeMgPxWPx5OTxt4PBYHh8wicAwNt2O4X8FQMIhcQJIJCHABtZpgkxgpfOwRgDCLEIOg3m21w8ZCx5orSs3fSnV33K63U0cDdgGU3rhDEYxQoSajxzsBUBiDbFgB5cTfGVYhIQQsEEcgRgPBT29n72u5v1BkdtAwIKIu0DhoFCBTEch7w7BXxtEUXislhxnhCoRIIs6WXD2er8l3h1501UWYUo9ZW8sr0lVBIqfmTYVayWTNog0xxFecrWLJCXAfuAv67X3ai85QWYiEp0BrAFXMIWP0UBYmn4pR21gGcV2d8DfSV8FSlOOKxCoLh+DtsDXuDRNahp6irOX6CaUs2HbwtKHU8dPqu+GZO4nq06H5/pxuMfl/qV4CEdfFQLlo4cXXhzASIvUGb5Tfn6a8qXUl9lSUG266SwU4mytQbao5xpKeASoc2ZdiP7OUbZ6CD1FX/89aJkuzY31/LWit8NLMn0qgVuEHG50Bg3w7KSKAUF6+OqHYa0lfUzthRR1EcPjJ04oLwHI8eLJVQ3c7YgUhg3cX2f/ZVKcSrP9Sl7dCVWE0mnn59+W5pHTUbe3kdtJS3cE3MqrwBWGwggNIN5hRmmlaogNqy9KVQ3M6YRKVSyAJ+onKScVC/05g5M4KL2eAI4Kc5Uekz6wq+8hJFdklhv8NatHD4TAQcVYB4tXQOKVhnbeE11L6DTYM4huTF1jVkMPLqHPKV0lsJZLKwAtVGpcPC8Mp8b2gBOI9gEzGEhy0b2gCiAkEdF86YSuGezLQHHHNI4Q2ZaLUTznCBS6grVnSUY3kkuK7ynVJBNoHJCoygQqGUHDCM1K79bkmd6uyRfSDq0cuZEoaDjyLX6vH3uWi333DRX49UHU4nXHXC3e2dENkmHae7UrO3kvdozArx4DtGUjFPPjA7mwL3G1QMRV63tQT3w5GR4sh0T3wFzW5FwYxbpKvh2KOpKUNmu7RoHPSAEAn2NCNKDCmfJV5pR8iZD3JoxyvPFslim9LdVOnhC0Kih7PFU554SJfFkyqie3Q94E3mdM8SwYPETz1n8ZLFS2yzvGFw5eehSyMYg2QgD25Zx8cAeo0EpksvBobuGXkpo1320+iUAr37C/IDzHnDeA857wHkPOO8B5z3gvAec94Dz/ns4z34m324cv/5bewzua/IuStZP8SvnxmV6xv3xMBT2k3fjg/9OC5VyqzWNuQNs2vlE4NE1dTntUd9DbeSVEAkGbZWs9ltcUJfBTnxsbF/LLbVQv+3m6bFKdNz37xs1y76HHSLFtGEHoZ3qo00RfMy73O5qJnhbjmpC2CBLwUkMjKgKq9ocVmXn3I6mNjPXi1Y9Mx+isSnDo1Gj8WcTvQscXGlqo4Yhxq+5jLA/r0r78CQnjrx+CXFkWpcdQHnXXbHCESxgH26n/brBct57V5PGAAgCuMq/vd8rMdjvA6l4hNm6+ErQXIICvV3ltbgxX75CDLNb1LHDzppZ07CqZeGWrrCajV4StTnhBJLHuW1N6ecpp9UARz1ptW+jzYa1dctIKzSZXctG4OPBkEx+1+636i5Fmqr0HPIbMoPXzytrXrYlVPeycnaXaRWbOx6gybTIdwSxUh7POH6JTzJUn2uWpdjQEsv7uPwI6lWVgENPbDvh/6lo8iIJMRaWF7RMQ0b0OR+ipTQr6kU+S+RPAi8vsdP0mYA8nJ6BgOkJ7prPsGl5a0+mRhEtXF3rzai9OOFIxzu4PjoAjUzl7ACdrF8Ckn6RkQ7Sws8s812d0s/FQrm9wbgsxU/Kc2MSfXpwEMK7Pk+kL6HqiY0vlYcbqhMYG/Th2SYa2r5ukrksRWabMUjhueDKblH7wLXmzvNTG9e8e+aMNk9fjVLi7YgqKTRtrMAC1/F9US1XMYN+rtH57OICW2Qa20sxwk7lDSSGJWB6GEwssc9sL1bGluMmhaREMkg4ZP0eo77eOtlT5iZ+twIMgOLoA3PffyZsUjWRW29Cdy/zL8941tHaG32KB+hzBRAs4Vrn7FlKjmcEKTUmWCFBcldKBjShPAxEvWGHtIc1cu73gDDJHxewT/SnLElUav5S6rNQifyhfFQ3hKoNNXZTTGJ7//z7P/Zt2T5eCjDquYW04saV+M06jzn0lJ94ptRBkmmBjVbRtK/xTEAAMHVluFnlxSM1+QfYBgCPIVf2qHNoJhEYLLGxzdBiWuHZT6JC2wmnIjWD6AQqjoEA6hwT5BJqsmsobzDnY7zAIMYnYBNmRUTABNXCdlMFCiKQ5FTLocJoe6mYUbcVttdJ7GWeZngqQ92TxOeCxzE2qSIKCUSsKSLmXgBGB0Z46A9aMl8ulz6n1z6A1wM3Vx/8PDp/8Xr8oo9z1iUWLPWAvhOqIMMwknuXqyw92/DjH/lDOqRU2gB3FX6wkXy3H5E0zbqSZP63fovifMcAUjpIIi4JeZAqbl3A/uBdY0uLDdkO/3cGbUJQRfCfg3Rx8u0tYtP3abRe42P7GwUK5rAFMJCwuxWwKtD/7E9iOiVwhbG8/GUMTYcHNonszPh9f99yBys5rv9CTvbeOWizz/6s37TcJdd22/wX7utP/3HLHbuq/SCn3M8l3qQUtC2uysEAOoGdiTkxqWq3XQ5U4dQPLzCtcpdzS7xxRXjDXSD1/FW8qtBuQg/LAv5F0XdO+Q6DKiCA74vh9s3GCUWytqNRSlgk/QsHR6Mn
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: eJzlWetu2zgWfhVCf5oMbPmSSzPBYLBp0s54LknRpBhgm2BCS5TNsURqSMqOx/C/fZJ9tH2SPYfUXU6aptjFAtsfqSyS5/qdG7XxQqYDxVPDpfBOvV+4NprQOCaKLbmGl5rIiFxQQ8kF10EsdaYYOZspxhImDPnAAqlC3SPSkoCTaxLx2DDFQkKmayLVjAquKa4SJWNGqAgHUpGLizNyw5I0poYBGcfNvxVez0upogkDGto7/bRpiXiZJVOmUCrleBMjiV7wlERANaUzLiwzn5wRwWbwvGQgBcmEYjSkU5BgSeOMkQiE1WRKgwVSuB/e+8CaI4s/M6bW8EOAFPBTRpFmBn4r9mfGQTHvFM5q1vN0MGcJ9U43nlmnuJULw2ZMwd6QRTSLjXc67HkJFzzJEnjebnubgmzME27aLJu6/kof8CARu3RWzGRKkJRZrZn/UgFHDanq/voA7npawHfW1ejnq7qf8aB1h5mzDngcZHrk1gth5XctMxWwWw99lL/KNBez3zVTS44rDcWMynbppY2CM15dEyRVsS0hW2CugNwkfFrFj4LDAplcoPlpR5sOhJ/lhlLcO9ytU4gzpnF9PBzif00RPhd+JW+C8QsCBBLcLAxSomka88C6ZfCHRnKbmjipkoAfwx3zMuZrklKlKBqFG5bU38vpHyxAXoabGF/U9G9Kf0a+mTHBFA++KbMKSWTIYhLQFDDMtMUJ+JvTmGtIHLn8NvdQsSZO4FeaIDAAWkqufHIz55pwe1YQnVl5MC5G+yRQ69TImaLpnAdwaAYpAQ0HqYeM9wnNQm6AEmSbW3GmeQhgVTKxUtx6OgsCprVUgMlAxlkieuD3UnI9l1kckilDKfEsZrpYBgsWYgg+9IU0fS76CL8p1awEQYWKTx5H0DmtLhGtvdyeFozuEZ2Om8Aqf4FZ/mLhtaApcDf5W/fyR6rn1gsJ04YmqQeIanoVeHWA1/MgOhMKCMHoYg9w0Drx+Ojw9Wg8HrOT4HVwMJ0eBOPg+Hg46ji1RNzkwts2VHk2LzRQieQOg/docJlpqCe3OXnwxzQzLq+wYC4A1linqMYqVXML5HVwyW1NKJtDmMAU/KnDN5UQIDbu6wsusry7bc01X2XGk8Nvxx0tbwBx739GmCP2ZI7hOTVkRXUtIrxtAxbPFmTj+/52J9c6L95mhRHDwt+4AaOaq676UwkJnorH2OaAbzKdiBDzkA124FkY1Soas8iQaUzFgnBBdkCerDDIwbNBBskWNCbNCPAregldYzbQEG3gRoAPQAI6EoQEF77VbkdIfaVFi3AAJogisodZDBT76frqch8fKAHtDfQkkI7X9jU5p0JaDIMwtmpeI14Z7saaPnl78458eHdOTl6fHPmETIxNi5QL16AhYCLO4lAX8HF4J+whYKkBG7gsNoFS2zRW/XdhAGy8tp288myr0NF0HByEh+woOn7quWM4ZIPy7/L53vWPZ/3RPspVpbdnizQejg/7w1F/dHQzGp4eDE+Hw793I6GgizJYjBV5HjE2h+IJlSv00fhVgplcX5ETSIrk4805upsRFA/FpBlEjEIl3qwR70seZjR2odONBreKGbTX7guapK7Au+qL8s/h0eGIjtkxe310/O1wOBwdHtEptBZd3EZQv0TAsHBSQWgIvSrJwBsuSucAxgBSrAE4G6y3hXksWIpC6UR76EeLvq3rzW6gLXLLEFGTMCYjIaGgihlz/SN2V9qUG3rwFOGSJBw6hFIIlCiF8srczy/D7/PQGxx0AQQUmOpDDwOdF3ZkFOpuRCGz2o4izatY3rf3IIRTDra0i61ga8p/XTQtz1eiLipkqa+UleytGAmleGXIQsgV4S7JtHfZOmXLBTbw0PtAvMI/HOKKSeyprvF9tavdtwSZAmga2MEeGWDqyp273XYUyuelunFGmESkgWBs9bGP0bvBzbXBy/a/hC4pj3GGrNMeHxXEUdaXEEehcRTFqgEhUEyGJYcDYOBefp72ZUvkYj5sWGMIBCG2iyZrZ2l/rHw7ICj2CqtaCYc2C9sDOC6X7MG8nIOA0x3qOAU6mLWBVe+yq3mmAcc7e3DOaGhvGDbeuRs3+jeW1qY7rtnBqVHv2lPVtoPHGk3ieHmW7yF004ju545odYWYUlKdQ4pFYfD5osbzrmuMZkBVp3ehqFTucIjo6JDfkYYqe7yh2F2lGXoqv7uxaaBjlo+iKmxe3Qm49cgNv/+nppkAPyUgL+DFBwStZdOykW3RIDFys7ZXY2cp/5nh4x1efLxhVDF1Bga2b1BrOsM7tMdvEDTaBoSaS7CiN7PXXClFAt5geTAAV0R8NsCeth+Wx/u0OD7I76MG9VBz8u+6u7tgiczVg32Zwk5hbkyqTweDENb6NOU+h7ldGJ9LD3VqErg2GMazx2hot9wmc1dZzfXY1ueF7aqrDvcivw3KY7a8BTzLcVsUq9Ylx/sJWbA1QXSDXXLM4iVFcd2YN+n3DTr3eWogSQYtztSW14g/QBlYwfAFm61I5J7sQWVlloBRUIKsDVIasP0eYf7Mb5E9JfnB79YyU2iOPgj3/b0df+oo2XhT++td0VD89NtNVzfbYUHDtYD+OKVaF+I5SrnMOLk1hCClBW3E2tRvD1Q9IfoN7+zA4pEsQh8aEhuSCeiJIZWlqVTmb5U/S5fwH6pXTSDUMdTSpjxE9v71j3/uY79JyfWKAbznbniDAWpOof2010UAMx7l7iT5lSRoLJd482MHA+iWcX6Oo76WsJtBM0RgEUBg1r38vL12DrC7g9dQGXt2IJxxbANWeF9hLDMtYx6SVIbugkPGcgYJClwsgAD6HMvhCsblJYtthceUgXmMTgETZm2JAARl4obkQEIS4hT7e+swq55iMztE460J+IySKMNbe3spZuVMqBCgm4c9R8CEtkmxiAIAHYBw7A87Nl+tVj61y75Us0F+Vg9+mZy/vbx+28cz26rzq/yAsRPKIMOEUkQXJhDnL5zj/AN/ZPtjqQ1IV5MHLzxb3yvwfgjffPajRRvotcrzP/IhJA8TAy3QANa57TOs1Td5lv7kLQ/chS/k6fwOa2emtq1RoXaVrSE1zsGoSGizwQb0o4q3W3ztbsNtDgepARfh7oudutX+s99mdlpjgSm8+kRjj+NgZGvHswX/0g8tT4hSNO8vlGTvQ97U7JP/1seVp+za/Rr0Qr1e8BnlCbm+5NtOJfAd/lA2GbuWqSjyiHJHGGtdWndft9OvN0w/vMVySfNaWvURC9tH5A9IvVgS6xrtdkvhRMC/aNudR77DZAmV/ftyu1t59EBZhN1uNCLOP/8GSqBn0Q==
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: eJztW9ty20YS/ZUpvFhKkRCpi+2oUqmVZSdhLrbLkjdVa6nsITAkJwIxCGYgilHxLV+yn7Zfst09gzsoUna29iF8kQhgLj09p7tPNzD3Xih0kMrESBV7p97PUhvNXnLD2Uupg0jpLBXsbJoKMRexYe9EoNIQ/t1KDT00m6iUcaYTEciJDFhKz32v5yU85XNhRKq90w/3XgwXMH4II5cDF+NeinkScSPycUchjCBRoISbGfyuS/k+lr9ngo1eMjWB2Zvi5qMVYsIAqfg9k6kIvVOTZqLn6WAm5tw7vffMMkHJtEllPPVWq94mYa0OvkxEO8Zj5apP8Tqbj0WK41uta2YU0zcyoU1J+FTGHJv67IzFYgq/bwWDJ1mcCh7ycSTYLY9AyAmPIs3GPLjBET4NPvn50mAJ6RIunELUZKKFqUkNfXWX2DI2YipS0suEZ5HxTgc9by5jOc/m8Luq50jOpWlOWV/rL/wOO7K4a82pMFkas0TQqoX/uQIOQapr7KsTgLbQ2PpwMMB/dWm2tg+G9gRTBApmiw2OxJMkkgFtzMFvGoe7rwiXpAqWYaSd/EEAVtaixr+JwLSUduaUBP8SWBT01IzHFWnHwiyEiHN8XqgsDQQ0Ce31ew3IYxcivZVwm5kZNyyAAcaCaTmNRcjGSzZWZtYD8Gi4hAWbmWBZAoLD5fcAR0B1ALsjfHYJT94kpj+KHexC9A6ACKHZYiagY0q9ncwSZA0IsigPaqKYe8ZhZ3HjsXlb0o6pYDAVR0u8kiGZRw4f3BkOqITuuBJaGEeBtX9V9xsfPIkGC0KoGDYwIgewpT9zLa2CL/Ip3F0S3slefaYSM8KeRs6FNnye4L10ymOpCT4kQPXGOxVhP6lfigh0G3oA5jqgZNj2LGs810aMyxAuwOmL1PdWdb1snAM3KEiV1v2q/DyqDEq7VOKB5thW2x2WYaSJ8EZ1RxrG8tVUxCKVwVcwpTPfuQpFBLhLCBEkjoYmgCKEu7NqTS4+XjJrxk80ww0F75qqBWIRwCepb8x0RvIgdof7oIFlYtQ05ckMQmeBPAL84T7jWSgNjARAvIrPNKiGTVI1JymuPJ0FgdBapVceCBJl87gHdlxIrmcqi0I0F5AS+6LJRCq4ERSd7/qxMn0Z91GlaLyFo2wB3q7qNbrqntOnRR79RJhgI9DKH6CWP0R4EfMEZjfurr35A9ezGpS3hCaAYM7Bb3rwW9xBR9rEpyfHz4aHh4fiefAsOBqPj4LD4OnTwbC1qYUfHr1E/FSWsvVcqKACaa0J3qLCVabBt1y54WE/xpmx8BXBjGwC9oVrpEuVbYGgC1tyVRHqimaOMT5+aM2bKAgbS+cymqHgelXZmi9S4/Pjrw87zfXtTwhzxJ5yGMZwsOC6YhHeqgaLrQW5931/1TlrdS7ZnMoGoV+lAaWaN+3ljxU4RB6vm9YBvj7pKA4xOpOxw5y5UmmhkZhAzIx4fMNkzDogj3Esxp0NMvBHGFPqFuCX4835Er2BBmuDbQT4ACQmkiAhY3J2XSb1hRrNzUG4gLqHXgwW9uPFm9f7+IMzWL0BwggkZUm32Xnu10EYHIZdIF4FtkbCNXp1+R179905e/7s+YnP2MjkIRVGiyICDLjzKNQ5fCzembgLRGJAB9aLjcJeQ1nV61wBGJNXLb+ytVb4cHwYHIXH4mTy9KHfLcXhNCh/157vXfxw1h/uo1yle9tapMPB4XF/MOwPTy6Hg9Ojwelg8K+2JeTjogyEsdzPI8ZmQCkhcoU+Kr90MKOLN+w5OEX2/vIct1swFA/F5BlYTIqLeLFEvN/KMMvjdtsa7FP0oL1mTlIf6g1SuEf5n+OT4yE/FE/Fs5OnXw8Gg+HxCR8D4W7jdgLxKwYSCoETSCAPgTayTBNjBCudARgDcLFIOg3G21w9BJY8UFrR7vqTmz7F9TobeJiwjCb1gdEZxQoCajx1tBUJiDZFgx78muAjxSQwhEIIlAjIeCjs5ePwux16g6M2gGAEkfaBw0A+ghyOQ9ydAL+2jCJxUcxxrR6YcCJBl/SwYWx1+Uu+uvUiqqKCl/pCWdneAjIJFT8x7CZWCyatk2m2ojhlcxaIy8B9wF5Xq25W3rICDEQlOwPaAiZhk58iAbFj+CWOWsSzyuwfwb4SvowUJx5WGaD4/RKWB7LArVvYpolLLH+BbEo1b74tRuq46/hZ9ckFqevFsvP2mW7c/nGhfxA8pIS6mrB0xOjCmgsSeYk6yy/Kx1+SvpT7VaYUhF2nha1SlI050B7FTDsCThHamGkXsp9zlLUGUp/xx18vS7FrffNd3pjxu4blML1qghtEXM41+s2wzCRKRcH8OGsHkDaKfsYWIor6aIGxUwek9wBy/LGA7GbG5jQU+k2c32f/pFSc0nN9yp7ciOVYQrSJpx9/W5gnTUHePmbbyrFwTcxteYWwWkcArhngFWYYVqqKWDP3OlfdjJhGpJDJAn2idJJiUj3RmzkygZPa8gRIUtRUekz6wq88hJZdmlitsdaNEr4QAYctwDhamgYkrTK2/pryXmCnwYxDcGPqFqMYWHQPZUqplsJZLKwCtVGpcPS80p8bWgB2I9oEwmEiy0a2QBSAy7N10TUpcM9GWyKOOaVxQGZazUWzThApdYPbnSXo3kkvS7ymUJCNIXNCUBQM1IoDwEjN0u/W5JnerMlXkopWDk7kCq4oonzUFA4gE8TqeOV+hpWBj9rWelrpnuvmcrx6Y0rxuh3uZuuMCJNUTHNVs7aR92r3iPBiHaKpGbc9UyrMgXldVAsiLlvbg3zg2cnwZDMnfoDmtjzh2ijSlfBtkdSVpLKd2zUKPaAEIn0ND9KDDGfBl5pR8CYgbowYZX2xTJYp/G3UDlYIGjmULU91rilREitTRvXsesCayOocEMNCxI88F/Gj5UptWD7QuFJ56NqQtU6y4QY2TeP8gS2juZcqlVpxY19KatddWv0cglevMO943o7n7XjejufteN6O5+143o7n7Xje/4/n2dfkm8Hx61/6jcFjIe+8ZL2KX6kbl+EZ18fDUNhX3o0X/ltNVOqt2jsvYNPKxwJL1/T1zB5991BreSNEgk5bJcv9lhT0lcFWcqTQslOSHKnF9rM94U/9Hqt4x33/sV6z/O5hC08xaeAgtF19i6m8il8NDjxNOZJkacRcd1G03ScGu08Mdp8Y7D4x2H1isPvEYPeJwe4Tg90nBrtPDFZUisy/xH+INb4tWzV5S5ClAE0DLao6qH7AXl3cuW1Nn8K77+WryhmiE1EGjLHBY9eNd4mNKx/eE/9l/JbLCM8QVMc+PMkHR1k/Z3AUWpdfk+cnA4oZjmACe3Pz2K8bIufnA2raGMCAYNs5yXpUkcECIRVPMKoVcGhOQRzAzvJa3JnPnyGG3q3R8dSIhVkTWFWW/fBBgmq+U4PrNQ08o/ITqebcpiP9vJLROlVBJxpq8bB53GHVwmtlTGbnsknYMbBtRP+2ZyeqCxZpqtJzcMEoDP5+WZnzuq2susGVvbtQVizueIDoaQ3f4aZKfbzgyL6SDHfSHZAiN9FSy/u4DHxedROsao7/xqp5J2wpAJ0sJEFZ3FbQiT228zdVUP5yAgMrlvVpmoaOiONCZJFmSQf0zhL5k8Cf13gy64XgqUjPAIF0B1fNp3iSb/3ZJ426mbsXSd6UzonR0bhT7+D26AC2YiKnB+iJ+mUFsF+UgA7utz4buDqwIXdtl/yEHjYsHZtVhj2O2HydNldOV9AuS5G3zYxJ9OnBQQjP+jyRvpymPDa+VF77KN6FQac5XTeGto+bw1yXW2AzHgJQvhFl4cnecOfjZvnbV3d47sx5iZw6NEpOb0f0RgR9Cb5JCdyJwMvqaydkM59q43xyjpjNM43HxDC6TeQdBOUFpMLQmERin9gemKB9rWZSIASkg4QHYr/HsKLXGPaUuY7fLMGAUR19EO7bT5SMViF3743p6ruc3uE7y9baiO8C/b2BbCXhWufi2ZGczJhH14RghQbJ/CkQU4eSoeO+4YlLD9915X4E6CHZ9xzWifaZJYlKzT/K/Sy2RH5f3qoDoYqhxmqKTmzvP3/+e9++frtYCLCVmU2lIZ21r+qa72uYq4LmXy6klKZB7oLVjGjS1/huTwA1da/TzDJ/CUSHQAPk2nAbeEqP0vOpRFK2wOqRocm0wne4iQptuUlFagreDrY4hgFwz5GcLFgkbkVEfAv9DzpFPgZMmCUNAhBUc1uyCBSYtOT0TgY3jJaXiimVNLCGJfFM4iTDt6tUoiQ55zyO8bAZMsBAxJo8bG4FADoA4aE/aOl8sVj4nB77Kp0euL764OfR+avXF6/62GdV8vByH9B2QhVk6FFy63JviFxW7R/5Q8pWlDYgXUUePPf5iGPUTWxXItdfeCTbodsAjzwAlyqJjJGy7p2n/uDdYmZnfbUrBHZ6a3h2+piz3GnONNf1qhyqLn02OMgZqBblur/HpOB9Gq1WeNueEiZPLjWiI+wutlUV+b89L92p3Bt05OWxaeqOySpFkK0Ff+zh5wdEyROqUpJrvEjJEzxSn3vvHGnaZ59xIL9TyDzixcuqjLnw2wPucfrdfiFFwvTXSV8Af3Vd5Fq0EbYXBrmkumPthKpKu75/hXGSuyBaEogbIhDuB47eKWuTS1gR8C8qtLPLN+glIaR/WzS3T9Z2KKKvbY2awzTzv/NwYKQ=
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: eJzlWtty20YS/ZVZvEjaIilSNzuqVGplyU6YaC2XKK2r1lKVh8CQnAgEkBmAFKPi237Jftp+yZ6eAUDcaJJ28pQnUQCmu6evp3vmxfGEdpWMYhkGzrlzLXWs2RWPObuS2vVDnSjBLsZKiKkIYnYnppHPY8FuxUxqrNEdp+VEXPGpiIXSzvmnFyfAP6DlgcqKSE4jI9H3sFIS04jHE/wuS3IfyN8SwfpXLBwxXhMpo4J1SvyWSCU85zxWiWg52p2IKXfOX5x4EZEgOlYyGDvLZeulwuR9Mh0KRRyUcEPlaRaHTD/JiI1CxSI+lgGnTzvsggVijN8zwfAmCZTgHh/6gs24DzFH3Pc1G3L3iSh87n7uZJvDJtQC/6RKCUcjLeKS1Firm8SWQSzGQhnNjHjix855t+VMZSCnyRS/zX5Ssr6cyrjKsrzXf/JnWsiCpj0rEScqYJEwuxadrxWwB6keaa2O4BtC09dH3S79KUuzi4sx8kpwcUMwDGIixqPIl66xzeGvmii+FOSLVIidxNLy3+CHhQ2Fw1+FG9c0d8HiTKYwiX0ZCM14wHgu8lDEcyGCzE0HYaJcgU88Zh/ca/gfGwg1k3geT3jMXBAYCqblOBAeGy7YMIwnnYegpPhPdsvPxrIULkbOluPzYJzATPg5Q9CRlHhXjKvsn3/lr0kLl6CmQt83NsvF/yCUDL30k8GEU7DcCgoalxSgKcATFYVarH5dFRRE8sxHif+Ga6lTMhcxlg+TWGhjN0/cjMDcS6x26YOMe9+rPsnsvv7NT1xTwojgZnhqvOBKjBAYcbaMuxSqzmOr4guZPlc250pxChYJlemGpFFzBvqeouf+tq/p78+Dm/ft6yuWkta0BMaqUVqT4LYIBOnhXzmSMNsy9YFd5BfPHIQEudNVcyiQnsrC3U2+JBmxYCMVTrNNE5vcKTfuvD+4YWfH37V7LFvDyEXYvuiMO2xPBHuUY/f0bO+ACGcuvpEuCZ1+TIaJJ3KbUmZ0uoqdP8VubN9DkM0Q6UZre9KzW6uG6Z+0xSr7lIKVoZIYNmdDcFZjHkhtAo9cQMcyRqx7jCMxMh+F0vcXzKOQxENSQrxgEvkxWLBfEyW1Z1NLJdl5JseZigZ3IiomlhPlm8rmJVDKYgCZQlWP7CgZoiL8IhablWgU5uZbZnYpe8LaZVao6zSm/PlaBGNAlfPT7iaShshytYudZTILK5FPimggBKgy5UhpeC830r2/vTYJqqzNb91uRo5pS28JbFIrMM3AoUx2oQ3ymk+kOykUWHg5cBbcY7m+Sm103OLXDI47CecIIMGIIHHQICq8Drt5M/gbuzE08CxMfI8q9d4avnu1mh2F8KbFvfHaircTjVtBIAb/53V3LMKx4hH2XCCM5xqqRHK8Di3QafD5nNOubvFxIpApAPwQop7RgqVFCi7JvNFxfy58DbsZsplStVUX0GVB8wTdFpkhq8po8pEc8faqvH+CBaeUVDxynJxtiq2eRGQKU7N6N27sY3kvGWAzTgLNEeWqgXalSU4HEnAbEzAZytpI5oP90FaAL5QiZ9kI2DYno9V/W/Eo4r8G4iIg61kwq4DM6nDj2hBA/wQKJgFsZFkBmZvx0JqkYJjwnJBJahylSkfCReK1hjU4DzDKjVHW5gTfJX2J1Oei6lGz9NwOwrgtgzbJhW2IvGsqZoa0tBUlqMV0M3TMg9kp4Dnn7PTkVe/o6Ei8dl+5x8PhsXvkvj7t9jbsEk31lwpdM6/3ddntw8xDcvItY0EJVMADtDsPhtGDQ5juAUUBP2uoelsh3iW+b2prxhTZS86kl3B/GyfORTTBKwKNhmEGbFIQYBiGvuDBOglSo5Y5DVaUiJNXUjaxgheJcagaoUnzRpEO0dU27OoyJdXMSLthtINNaYhR4zAgGixzW2PLKiOTrcpd3WbYfHtN9cYAfcjupuuyUC60g5v7h6vMoKASmBi0yaKeIRp6yj+AfD6aWMvHdKgbOdFXO/FK29omd60VGhDdkEcpixnsqydgCzsjh5mSsa6v/irVfShQYytyxAiOFlxEclDMtZtT9g2t+tAvp+hSncp32LJNCGEQPuPSNxM7rLVFpj6b0bYQq2zytEtdQZNjgiq3V32M9PexCIBz3L+zjAObIh58gIsohmkshtH4BGBXQ3fpxMvUH8I5dsS1B9gAobEVFc477I6aQGnWom4lFrgi1HoHzFWLKM7Qjxk2ceJjRlNHB4wnHmwRjDsPwUNwodFt2AaRpHhwdOJCIzpUyN0odsk0aKG7yyVfQWPqALGWsoUfuk+7VETT8dldpQXG6tM0fvYnWYk+glZ+h1p+F94g4BG4x+lT+zCdCcVyCpCHBPfHV9azs4bKmlk7ramFrWzNq5RA6liPFB4mGsjjISUPeyAPW5wk3EmAEPBhF64JqRTMgi4cJnkoCPXgFOBYlW/aAdQyGg2JncdlwTTfBlBOvjtqnGt8+CUL4jD1YUJac64LEeEsS26xtSAvnU5n2ci1yEtWWdnx7EcZQ6nxTX37X4MW+oAsBAi05Zkp1WzUF6OYDX0ePNG4pMHlqcMKyLJu4nMKXVaOgM6K3pQvKBtoRBvMCPeBS4ykcQkZdCwCqofUN2o0CwcwMaBhX9upEA1JD+x4iHrFDrugLtA8Zpc8CI0PQxiTygfkr4K+pvOI/tu7d+z23SV7/er1aYexfpyBdFADHCSHGUnhezpzH+vvAOwuOkDowGaxvteqKKv4f6YAGsEva3lla63w3vDIPfZOxOno7Eu/10KBJpvvD366aPfswDBPb1uLdNQ9Oml3e+3e6V2ve37cPe92/12PhIwuyWB8LMvz5GMT9OyoXF6HlL9KMDTHfY2kyO7vLsnc6GylHXvxBBGjaBNvFv0cotvQqUeDfUsZtFXZU4XUDWGanfLPyelJjx+JM/Hq9Oy7brfbOznlw263wW9HqF/UrqBw0tmON0UAJtpAKETpBM7oIsUSoDFDV1VAZXmhtKI9t0dPbVPXy2hgA3QalQlTMgpCFNRgnOI4muTqOP+ghV8jehUyCYSQC5EiOE/Yf3fz3+281z2uOxAoCNUGhpGaIAvjqLsj4FWLKKK0iqVnji2EcCSzeXQl2MryDzLQsv0miqIiS32jrGx/LpgXBnsxewrCOZM2yVS/MnXKnuZZJH2Q9kmrU+QvocYPq69qZ1aJUjRFLZ+trJuhXtqvzTFuetZbVE6PkkgYIxgrOHYdvTv6uHBobPDvCk0XaR+dZsRJ1q8hTkLTMTpVDYRAdqqdczimYZN5uJn2+4rI2dl2SRtdEERsZyBri85qVb6tIyixR1Utd4cqC4MBLJf35ZPHHTkEWF2jTjcerJtVHat0sLLhBLzY8ZQc9tGQngjumbsdL86lbUjad+khZO1OgDmML1XE6kl97US1SJNZXrYNOwHezs5stzn2L25ZKBWqSyRhEoZ+Fwegj3V1lUNutbrJz/LNnXTJf2rkm0aguT7ecMJfUUK2TG/NmERRU8t9sCp9TtEIVjUnf2HV3Aptr1ggzaINSoK6gk7tpZO/qIL64KcCpFaU1hnynmFT0ZFBuagtZv756cW5iKQ5Pf30SPeK3giuhLpI6PwPT2jXfKyzOwSN4yRNuoFQEzrHccbmlpO52nXuHM6OD2GKkRwfUi5qe/nydn7Id/iy8cLY8rCYp+ze7JWz6uh3GqZbd9JjU2cSx5E+Pzz08K7NI9mRY8WDuCPpJKdKYBBTDhyvo6Ht6yqZx5VGbQtj/CHT62qSZB+kl7XShJdfELtIgz7DApUZ0oc+nVMzSg10cOam19PMvQBzEy3tgT6X6HxO8yqbJpquK1G5GslnVNk5elt8bERin9k+IsoeUMUKFd7oIOKuOGgxczmjTPacpQu/XyAeSR1tCPfDZ9NdFj3oxRma/95leO3nj3f1vRkACzz7hPYj4lpn4llKqczUGJeEYLkGTTSbymoWrCA32Y2u/0HjozBLC9xOrRH/kmyrkygKVfyPlT1zk8gfV4/KjlD0ocpu8kVs/3//+e8BwXnOBnMB15/Y3hj96YQD3ZtpHNxsNcvU6U0xJJYZDdZM34VmhMYT/qitQ3wtgDXT+wHxopWuN/NNl8AzHgN4tEy/PZaEsuY0DooNMx360mNR6Nn5UeiHYyQvmDgAATMsBdqYM1/MhG8AFKUTynF8CJ+IF4YIXDCc2hmEGyJCpTntMQYz21NibGYUNJSiux9slNCtEDNzNHJOeRBgbw5BOlcE9uAziwI4HZzwqNOt6Xw+n3e4ed0J1fgwXasPr/uXb98P3rZpzXIFrFd2oNjxQjeZZtNop3C3yLTJneNOz7QfoY4hXUEeuoG407XYqncXStFXXrJNfZmuWx3itQwKV0Jsmv3kzKgxs4k2neM1plq8O9/mdu4q2yK1TaAU4vHyQvj8XvnLJT22l01NDpaa7Oo1z72KCvhzr902Koou9xRu35rl1Dea3L+14Lveof2CKFlvs5Lkkf5RJoZ31Of+bYpeDtj216YbZctKVLAoipbJvNlnlo95v2D2YNdRZo+Km603BUXo8ONbKg48rRyrqvlkqmb6g6g3SlstoFYEe7lrzZLvKTWgjv2Qf27frF2Qlxz7NemOWqX/A8yugcI=
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: eJzlWt1y2zYWfhUsb2x3JFnyX1JPp7OOnbRqvXHGsjczG3smEAlJqCmQBUApqkd3+yT7aPske84B/0lbctJe7Y0tksA5B+f3OwAevUAYX8vYykh5p96lNNawC245u5DGDyOTaMHOplqIuVCW3Yh5HHIrTM/reDHXfC6s0MY7/fRYo/Q+mY+FZtGEaeFHOjDMRsw8yJhNIs1iPpWK49AeO2NKTOH3QjD4kigteMDHoWALHiaCTXgYGjbm/gNS+Nz/jKwlsvg9EXoFDwqkgMdoMjHCwrMWvydSi8A7hblGdDzjz8Sce6ePnl3FOFQqK6ZCw9hATHgSWu+03/HmUsl5Moff63XnMSMbyrm0dZbVtf6Df8GJTLWtWQubaMViQasWva8VcOCkqnJ+J0PQv1RTFqDNgsJmPLeZzWzGxisWaD6x+3EyDqWZiYAZy21intAo99EqWwk8jqJQcFUWOB1aFXg4YVYnosMiFa5YIUchJAfhnc5E0LtT3np9jwKYOFJGGGR50O/jvyrhzT7L0LlBQD8C5SqLJHgch9InP9z/zSCdx9LSYh2B1ax0XFHBBf2cfB4RJWVwrTmqUcKqyu+j8W/Ctw33OctXz6LEhlKhFlTJgmNhl0LAGxeZoyjRPlhYBcy9uDXoASOhFxLe2xm3zAcCY8GMnIIa0fDjyM5QnWVjfnK6+ELuHcAfkrPjhVxNE/BV+LmA6EYp4Vsq4zAoPfwz/4zqOQdqOgpDctxc/A/goFGQDhnNOLrrtTBWSx8VgM4XJzqOjCh+XZQUhPIsJ0n4hhtpUjJnFqaPE1Q7GjQQVxNgHiROuzgg4z4M6m+uxUKi0E9/+ZmbGcoCXgdvyT0uxASyg82mpZFx36k5SabPzb6A61dTb91wBhyPKeT2emjw/y+jq/fdywuWkjY4BYzVoFQndKskhPMWuZzJAB7lRILZ1qkPvER+8YUDIYHudNEeI6inqnA3s+ckQxZsoqN5tmhkkzvlxpUPR1fs5PD77oBlcxi6CNsVvWmP7Qi1g4Vmxyx29pBw5uIb6aLQ6WA0jJ3JbUol6bSInb/Ebmw3gCBbQKST1nZk4JZWD9O/aIl19ikFJ0MtMWzOhsBZT7mShgIPXcBYaSHWA8YhMbIQ0EIIxSPAkISXqAS7YhLyo1qx3xItTeBSSy3ZBZTjqLaBOyEViuVEh1T/ggSUshqBTJFuRjaVKv9XsdqsRFKYny/ZVTmfPcDcdVZbmzTm/MulUFM7806P+5tIEpF1sYoXy0QTa5GPimghBHhtziGlwXe5ke7t9SUlqKo2v3W5GTlmHL01QKFGgWlHT1WyK0PwczmT/qxUYMHLAWyCe6yfrlIbHbc8GuANm0VLCCDhkBlwMEAUIA27ejP6G7siGvAuSsIAK/XOE3x3GjU7jsCbVrfktTVvRxrXAtENPOd1dyqiqeYxrLlEGN4bUCUkx8vIIaAWn885vdQtPs4EZApAvxCiAWnB0UIFV2Te6Li/lEaD3YhsplTj1AVwsaR5xHSrzJB1ZbT5SA77B3XeP4MF55hUAnScnG2KrR5ETIWpXb0bF/axupYMsJGTgOaQct1AL6WJTgckwG0oYDKUtZHMBzfQVYBnSpG3bgVsm5NR8bQVjzL+ayEuFFrPgVkNyKwJNy6JADSRQIESwEaWNZD51diemPCcECU1DqXKxMKHxOsMSzgPYJRvoawtEb5LHAmpz4eqhx3jl66KbFeqLsoFyxB5e1XODGlpK0vQiOl26JgHs1fCc97J8dGrwcHBgXjtv/IPx+ND/8B/fdwfbFglG148V+jaeb1vyu5eZh6Sk++QBSWgAq6g3bkjRnceYro7KArws4GqtxXiXRKGVFszppC95EIGCQ+3ceJcRApeoQw0DAvAJq19cqsErT3zqKCEnIKKspEVeJGYRroVmrQvFNIhtLstqzpPSbUzMn4Uv8CmuJPT4DBCGixzW7JlnRFlq2pXtxk2X19ivSGgD7L76bwslEvt4Ob+4SIzKFBRFIMuWTQzREtP+SeQZxm5J/lQh7qRE456Ea+0rW3f1qkVGiC6IY9iFit2eMDOkMOoZDzVV3+V6j6UqLGCHDICR1NnsRyVc+3mlH2Fsz4Mqym6UqfyFXZcE4IYhC+4DGnbEua6ItPcm6HmXacKf1FVgRaHQiq3VnMT6bupUIBy/O9YxoHNIRpCgBaxBcM4BGNgCEBdA5pLN8Ko+iDKcTtfOwAaQGRYiI6WPXaDLaCkuVC1EgdbIdAGe8zXq9hm2Ie2mrilrUeAfAd7jCcBWEJNe3fqTp0Z6DVce4hS3Hkm8UEfJtKQuaHUJXPVgd4ul7wAxtj/wVzMFWHkP7ykHlK/51aVlhenT2r73E+0EQ4CrfwBavlDBCPFY+Bu07fuZbojZOUcIB6ktz+/rp6ctNTVzNppRS0tZWtelfTRRHqo8CgxgDvuUvJgD8jCDiUJf6YgAEKwCzeIU0pmgR4cTHJXEurOK4GxOt8U/zfyGe6Te/frkmm+DZ4cfX/Quqvx4dcshKPUhxFnLbkpRYS3rrjF1oI89nq9dSvXMi9ZZ+U2Zz9KC0q1V83lfw1WGAJg8WkfnXhmSqWFhmJi2Tjk6gE3S1pcHvsrhZb1k5Bj6LJqBPQKenO+wmxgINrAjOA+4BITSS4hVc/hn2ZIfaNGs3AAJgQZdo3bE8It0j23OYSdYo+dYQ9Ir9k5VxH5MAhDiXyE/ipwNB7JDN/evGPX787Z61evj3uMDW0G0YEagEF0mIkUYWAy93H+DnDdh/4PdOCy2DDo1JRVfs4UQOcZjbyytVb4YHzgHwZH4nhy8tzvJ4FAm813Rz+fdQduuzBPb1uLdNA/OOr2B93B8c2gf3rYP+33/9WMhIwuykA+luV59LEZdOwCD3tQ+UWCwV3c15AU2e3NOZob+lrpNr14AhGjcRFvVsMcoLvQaUaD+4oZtFNbU43UFSKaF+Wfo+OjAT8QJ+LV8cn3/X5/cHTMx/1+i99OoH5hswKFE092gjkEYGIIQEGUzsAZfUixCGdoy1WXMFleKJ1oX7qThy7V9Soa2ACcJlXCmIxUBAVVTVMUR2dYNh/QgV8T/BQxCQghFyLFb4Fwjy/z3+281z9sOhBQELoLGEYahCyMQ92dAFp1iCJOq1h67NqBEI5lthtdC7aq/KMMtGy/iLKokKW+UVa2uxQsiNSOZQ8qWjLpkkx9FNUpd5bncPSe29Jpnt670+cUYaZ7HVueU7hNovxk/jkY+qEY1TgCS7TGTdnqUc1TW7LnbjQdjafn52VtDzArRRaiuwaMn6J3g4NLB/EEqAtwXqZ9cJwRR1m/hjgKjVcTsAxBTGU3BXIOh7h3RS83035fEzm7L1DRRh8IQrLIUNsWjVqBB5xnabGDZTL3rzoLAhWOy/vqQeYLOSiY3aCOR//OzeqOBbBdJtk5zaaT9oqX3hO9meABXUR59M5dW9O9SQ8yG3cV6KS/Ulfr1wAakVWmyRwvF4BHgNqzc99t7hSU2xOhdaTPIZWjMPi7vIl639RRNc6K2W3OlS/uqI9O0yDfto2a6+MNRxQXJ2jA9IoPZYeGWm5VUUC9shFw6LG7pvF/qpoh8NMK0gXUnwXEMrGp6YigIORL2iL89OidxZIOGD/d402fN4Jroc8SPCKDN7hqPjXZMXtrMjeoGxBqhkcd3pRuQ8UcCXj7i8N9MMVETvcxvrrFVaEuL6YTNl203+i6EPMoXY2XHhZ6M2tjc7q/H8C3Lo9lT041V7Yn8fyiTmBkMWqnT9Ew7nOdzH2hJAfdycSZqoodFPcivciUhmh+k+ksddOsZNX2Tj4M8XSWoTPjcZGf3kyj03C6hJZi/88VOp/TTMDmicFLOphVJ/ILFIMl9HQwmERin9kuFGx3LGM1FCLSQcx9sddhdCWhSvaUpRN/WEWJRnV0QbgfP1NXVXaKR29MT+8ynPLLx5vm2gi4AY57ANgdc2My8RylVGZsCCtCsFyDFKBUAGhCATXRbt6aDnsnURbp3O3VQkhLtK1J4jjS9u+FPXOTyJ+KV1VHKPtQbTX5JLb733//Zw9hLGejpQBvnrmeEPqyGQdUS7tQ4GbFDp5J70dBrljghhL1GwDCsS0PJ10TwWgBGCs9FberTjqfdvV8BI3wGupjh/rMqUQwsMRtEEvMTBTKgMVR4PZNojCaQj4CEysgQFuEUBSX0IUvREh1HjMEpi0+Bp+wKyICLhjNXe/tR5BzJJ1xkMFoeVpMqTdHcIc3HtgkwbsQtNdGcs65UrA2D5GHL5Q77suiAJwOnPCg12/ofLlc9jh97kV6up/ONfuXw/O370dvuzhnXeC/wg4YO0HkJ/NsD9Yr3aih9rB32BsQ7I6MBelK8hBe3eKyad2pS0XlZTdWU8/FK0X78Faq0rUHlyc/eQtsP1ymTHernsiVkJhmsCSc8/iIIPBWh+s1vnbXKCmDSoNWCdp3a8rr+Gvvy7YuHC+klK7N0nTsdihzby34Sy+/PiNKBqC/UpI/7zLsMzLmd2ILIe/xQVOacLU7Kz/oAW4WZuG4vLQm5CxX7p/eYiLnaZYvKtwDVbj0B1LPPqlViXa92DkR3PWjJ6b8gGEMNefHfLj78uSEvDy40aghBOL/A18EKG0=
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."
sidebar_label: "List OAuth2.0 Clients"
hide_title: true
hide_table_of_contents: true
api: eJzlV19v2zYQ/yoEX9YCtuwk7YtRFEuTrPDWZgHiYg9FgNDSWWYjkSpJ2XENv+2T7KPtk+yOoixZStckwJ6Wl5gU73fH+/O745YnYGMjCye14hP+QVpn2e+npVses7NMgsLlQhtWWmBr6ZZMsHPhBPsozB24IhMxRHzAC2FEDg6M5ZPP2w7oZZnPwTC9YAZibRLLnGb2ThYeuRCpVIKORuyUKUjx9woY6VQGRCLmGbCVyEpgC5Flls1FfEcIt+NbUi1JxdcSzAYXCq3ApV4sLDhcG/haSgMJn6CshQG38RJywSdb7jYFHZXKQQoGzyawEGXm+GQ84LlUMi9z/L3bDbY1bCZz6boqD+/6UdyTIFMP3dmAK41iBfhbe8c9y8AjtOqGZG2hlQVLp4/HY/p3aE03VGhBJhwk3QhnGHa0YcBjjdqUIyRRFJmMfWBGXyzBbVvGFUbjNZyslGtBcAGtZbswRpCPpIPc9sViLzBN+oZPz8l1bgmHliJUQLbOSJXy3SCAXEOM3u0DVftPBLv04e6lMe4+Eei8DdALTrN6NGxqhHIz3LV9vPf0jfmPDAtFrzHOVGCPAnYyB+tEXvRxZ/WnB61k6F9R3cGwTFjHcp3IRcicRhWmMcdaaiX85yb+nSgexOHg0m1Db/bYev4F4gq+YZNWGobvJOwy2rhqTg26OVkag6rxBHynCNu+OatO+3IONY9n4B7tI0VH5FntRDatC+AHeDM63CIPXzhMrITMiAfb2Meva3Cy9TngZDTRqcVEwfjV7LbXcIIKqs0fY192TK457sAbYwRcCntlYCV12TZ5rnUGQvVgpyqhTEIzpc89Az+hO1gREHoqPIlWWi7h3j1fg0LpHrozJeyqP1SBvcn3uy0/q1hzOPOqtn0O9/zZAuqT666XWS1MVuniXu+r8ZHP08cydbvgwBhtznTib0W/2wTVq6duaTTSD+XD/nKvxhTnHnwjE1in7Y93ImFSFSX5PEwSPPj50C2fFLUabeQ336+aINDR11UP/J+6Zor6jMIKt2BWWH5eTcdHKGQBKU66jR/U3oEwYIjPcXlDQ4UTKc1wqBYnPkzChUxL4x1oyQ2of6nRYTz1PF0IkuSj1cko9mdHCY4cQ1vgsDGqpoJhHMYCUk2GPTQinkOug914rjQZ7i2dK+xkNErw21AUMpK+EURSc5rJOn3eEaWn38Ow1ecuzE3jjmvKiiqYp4X8DTbtMabaCINfKMb9sHkaErLuJ4eGnV5N2R1sGPkC3RCSMWKzZT3Vhq56e4BzG2qe5SW21DkQ5S3kPTK1n8JvKxvZLXuhtAMP4Ax2Ce8D8v7LAYMojTqwExYE32x0acgdQzTuLQ7SmBntZNjyuV/9ok0usJT4r3/M+neLY7A02d4BTrXC2tq8CinYjNnLDoxgew/6UvTs7AWaaYHi5vu5VAtd17SIfU1j8UqKrS2LQhv3cxPPfUjk+2brMBHaOdS5zV6Ivfj7z79eMkl94BqnKGmXjNKawX28FAo7vVAJwzTbjzk+7WRMUdIriXeL2NTRm8nil2wxtBpPg0wVw4+YBG4zCPL+dYNDj9/G5jVAnYlMJXXqNU5xOLuSMqszmbBCJ8xBvFQ60ykyD4ZYIQDFnDrWmmWwgsw3YeICIigxx5xwGw+CKagxmHQ81sguUqg4vOr89QykZVaVOsVMsEWZZZS5CZpDduZCKbwbp7EgBnx5UDjqKsCkwyQ8jsY9n6/X60j4z5E26SjI2tGH6dnF5fXFkGR2zXDWxIFqJ9FxmaNz6uoiAqnidTw+fhWdREckW2jr0LqWPfSSDZNqNK4fOt0MbvWKZz99Q8Y6HBhGuCl9L/cO2AZ6/MxXJ9XbCgmSTNhTJC46JImMtMS7kNB2S6PZJ5PtdrRdvTc9dUpL4WjejN+903/78n7w5nfEnM0D3IvjRkXZjzb8qc/ofzGlHmsbS25oYXzp+a5Xt0jv3EqImK1oS/UHtnYzfH9B5CgCc9YTZ81p4Qeh1w1FbVrYbwJdzohH3/LacE+rqAe79j8YMCMw
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.

## 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: eJzlWFFv2zYQ/iuEXtYCtuwk7YtRFHOTtvDWBUGdYg9dgNDSWWYjkSpJ2XENv+2X7Kftl+yOlCzZctLYQ4EB60NqiXfffbw73h21CmIwkRa5FUoGg+CDMNawqyJN2QW3nH2ESOnYdJhyEjxNl2wqUgsaYjZZeqELYaJUmUIDGyYaIANpGbuGLE+5BfbsI8yFQW02unjOuIx7Sj+i6E1ua4V/yKAT5FzzDNC2CQafVzvML4tsApqpKdOeM7OKmTuRsymay3kiJCfRkA2ZhAR/z4HhSiE18JhPUmBznhbAprhJwyY8uiOE2/5tiKYFmfhagF7ig0QW+KimUwMWnzV8LQQ6JBigroFOYKIZZDwYrAK7zElUSAsJaJSNYcqL1AaDfifIhBRZkeHv9bqzqmBTkQm7a3J7r7/xe1Jkct+eNdhCS5aD2zWExxI88ay2Lb9zsX888pvANyL4gAtjBKkxNhAVQgUwip+0CWO1kElwJO0y744m7fWPpXxD0iZX0oCh9dN+n/7b3kbrXLIUzyuQqUhhBKUlHZ7nqYhcsve+GFJcNQznWmFqWOHN5IhIgCVegxnXmtOmhYXMtKmU3sLU441yQRsGQ9m7bUbEbYTRBWnbGbTKDZuAXQBIhHZvx6rQEVDl8M+fDPqMjUHPRQRoa8eXnQPS6hFWhyS4nXHL8OQICYaRdbbghpFzsUzyhAvpnPJUoq1UOormbkJvkSRVvhGtHL4BPNjlUklcaKcJIqgMm0YCEjT6LGZecg9EhIUYBYa2DXMtMkwrnuUPpoxTJuFOo6QRqlV3IPcgIsgwisAYdk0SrDDIzbUKhKbNUmzaNNfNU/2ZEvuQdHt6xCuPNt1SbeZmw0pNvkBkHau6wzUOcbmO8sKm9OKqlto9o1GhNTJBCXigMTT9d+6lXYsp+xDKwD3GiAydOM9bno6q8vEdvGsSbjQ0V3YYn3ORUm9uYp++rMCJ6zHgRJpaPIUcD0bVcTcWztCAf/l97MsdylXf3fJGHwFn3FxpDLAqmpQnSqXAZQt2JGOq4UhTuIzX8BO6g+UlQsuEazDeyiXc2+MtSNRuoVtdwNr/QxM4L7kZbBWc+67TvXamVu3+5vpPA6jdnNatzGpgMm8rcHZf9E9cnj610zXPKWit9LmK3a7o90XDZus87R6NWntfPmw296JPcW7Bt7p90x9veMyEzAvyeTndBqWft93ySfLCzpQW31y/r4NAoi/9tPA/dc0I7Wm8mzCD/QmPnzOz4yNUMoAlTtiluzwMc/Er0M8bmhbfANegh+hg94Z2zRO6ZQRjkUisEptCbcglyGWm0HlB4ub/nJNe0Juf9TACU5H0qMp3Tc4j6FE76brnckYPiAnx3HeLuYBMldtAuUKn+G5mbW4GvV6Ma12ei1AkmksbChW0J92xpQqfPIRh/PIuzE3tnTEliY9t5aN6JvQvyrG4PJubuXhY5mfVXraJDa9G7A6WjLIY/VjmZsioEfuLV9nab7dwbssSwLLC0JxCFXAq7jEkC2FnKOwosVv2TCqcyAjAamwazgcUgOcdBmES7sAOWKn4aomTDrmji+Re410PE6WZDatg4p7eKZ1xPFnBL79ft/fmBwnXnTFZjanoeaSSMyYz2yLBNh50J9MVa6dQjx0UN9fehZyq6ojzyB1xPMuCYmuKPFfa/lzHcxMS8b5+tZ0IzRza2c1GiT37+8+/njNBbWG8gFiYmR9u4T6acZn4+RDTTEzLcLq0wwkRd6zmAvcWspGl0crgSjrtGoXSgEeK4SImgV12Sn13AcdRx73GXtZBm7FIBDXuBd7IwTpjRqUiZrmKmYVoJlWqEixEGGKJABRzamALlsIcUteTqTRQveITzAm7dCCYggqDSeKRwmIjOE5aPmCxv8UkRer2YyhmnE0L+u7BixjpEM+MS5xm6WaNNRbwykbhqE4BJh0m4WnYb/l8sViE3C2HSie9Utf0PozO316O33ZJZ13PanUc6OzEKiqoAFWniwqIj9dp//RFeBaekG6ujEV2DT70Raf9QWc3hRu947/9Dag8FxanlB5CCzdAODevyjr8OZif+QsxVuJy4va1mEp1qxpj6Zuh00hvtaKR8JNO12t67a/9rkYLQ3Gv7/EP+u7HfoXau/k7KtH1xyinji98b3gy8UM/KT1CpRqnj2TyLz4xPULqkDvaDyS+9yPT4bT3XBdr0jf0oF1F9fNN1akplT0sNay8GaP2WN4cc96/pZ7Hy4ZYDwN3bhgofxB6tSSXDezducBToL/k370qr6jiYXt+vRH3Kw8qbDqplyYX3uDQ9w/PJ/9E
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: eJzlWM1uGzcQfhViL7UBWVKctAcjCOrYTqI2SY3YaQ+OAdO7I4nxLrkhuZJVQbc+SR+tT9IZkvunlSLHQIACzSHW7pIzH+f3Gy6jBEysRW6FktFR9FYYa9jvPBUJt8CO4xiMYR8gVjoxbD4V8ZSZqZozmIFeMCsyYFwy7tdZdQeSzblh8RTiO0gYt8xOIXzALWIsYk66cBd+LexUaWH8G5BJroS0bG9W6vdy9/ufZNSLcq55Bha0iY6ulmvA3xfZLWimxkwHsFYxcydyNlaa5XwipNPSZ8dMwgR/z4Dhl0Jq4Am/TYGh1gLYmKepYbc8viMJN8ObPqoWpOJLgUfGB4ko8FGNxwYsPmv4UggNSXSEew30IoOnz3h0tIzsIqeleCiYgMa1CYx5kdroaNiLMiFFVmT4e7XqLUuxqciEXVfZPus7fk8bmdx0Zg220JLl4E4N/ccCfIKormmvyZU0YGj14XBIf9potgVLiqGEOntRrFC6tLST53kaAmDw2dD2ZQNMrhXCtsIrK4PAiw1SG5i51pxsIyxkpgvLbyDjrMdnELw5CLlFcTk5oI1GJA3VxmohJx2/fJQCHcZEgqfFQEcPUOxR/DdUeldFK+8WIBudcstPhYlTZQoNxxMNkKEIf4LRAxSPTumcpIhEsVoWq4QFtzB0hoQYlVKs0I6maTqoTlJuTJWzu4E49XFrE6sEsj3oT/o99inKhfgU0Q8ulVxkqjCfon0mZBdQLwJJKXJFe/Cp2hBdN7Ge3WNZkDwdJZcO3y6ctIpMBmEfQws2cCqZLpzvzkejtePsR5v17tZ51tDlS803aKzcVjl01EoGdfsZP3d0vlEpVQW0qskhJpGodCYM+QVhlOGpHxAbPYZlfQ5pSn/pY716e9BdYi6lVBs+NLRS0pGAQiag0wXayktoxmq1OpT+Vi4mX8uXcu+35U1lnp0JVGGr+xo1PA0pcIPGQJuSw7ZgLA3y3VB2LW6noQkHLxNaIyayjbVhxccge4AvHQ5sL0KCDyBSS5F2iwebcuxP+MvOAWRdyS5UoWNwEeOePxrScAF6JmKIVqs6F3fnwuWUGr4gIpC2C7IXsB5lPvgvXRnaXVBQ+C9/XJY90O3yJyZzl63Mlf2ptfk7wJ7zAAOT2DeXl+cscxtqiVXpIIk5t9OHyTo+HzFavVHQqskUrlrnb6EOCn0B9uyAtCsJv40dM/u6Hy4KJ3hcpFvbciW2jcjzR8cpkm5zIsqUiJlICiQ5TmusEkhwlchcu9gF7BUXKVHWR4NCJkmc5pp4U9f2G0SxPeONQUx0jOoxl125J15tLM/yjRwN0zbj1r/66dkmGnLPKglI2kNGNQCoOC603uB0kUTfQEy+zha2da06ZxsB1Dwzmq/tqZUL8pLCb0p1K2xKL87rVev57E4sLa6ALcy3acQTv9px6EC0iYzcIz5S9IScpCx2/pJ97pB3SYsbjN2xVsZn6HQaPpqyD38shRPWxwgn0DTDUD9Cb5cjRaXhKSrwL3fLfr8GuRwsWtYYUl3j5pzIBZGzWuytUtgYZbd1YK5inCBM4TqIhh/QHCwPEjoq3OTitbxH1vZ4DRJ3d6RbXcDK/0MVOBC6IXMZnfjR5aBklZ3ByQ0xDUHdCWfViayGTOZ1+U72bPjExelDx6Vm3oLWSp9gvSMw9Pu0obOTT+upUe/eFA/V4Z4Nyc8d8Rs6T22PlzxBYp8XZPMwvkfBzutVKwxif7paWjuBlv7oB8//qWlGMkwOBokPpp9Ts2Yj3GQAS5ywC9eDj3PxK9BP1/heAvIrfVwQT7hy/cnyCV2jRIGwvFX4iK+zQEyiibva8MwiGsyeDtD2YzEZUOM9MDmPYVCymgPfMQ/CJURESAjnpmuaU8hUOAauK3SK74hamKPBIMFvBzwXfTHRXNq+UBFhX2MPlir8ZJsM4z+vi7murXNBQeJ9W9qovlLwL8LlS8jN6sLnOMRn2V7awIha3cHCXSfQ/B+H66bQ+gsoqfJNS85NKAEsK4wlKowVcCzusXDPBfK0G4+R3bA9qZDVu6FDY9NwNiA37PcYjdVrYo9Y2Ph8gRSazHGA4F7c9KkeNaNhGd26p1clp0AW2z1bkxLl2ORLeF5SwEwDfAsEqyzoMtMVa7chqrKO/Obau5BjVaY4j12KYy4L8q0p8lxp+3Ptz8ol4nX9qh0IzRhaO021ie3989ff+0xQW7iYQyLM1A8lcB9PuZz4waN1a2n86IEnVsg0QffZyLLCYJMxkI4PjMLVgMNVuASyi17Y724YYyxJ9Bp7GY7TLMFhhBr3nKcpWKfMKMwplhPVh3gqVaomWIjQxRIFkM+pgc1ZCjNIXU+m0kD1it9iTNhFeaOl0Jm0PFZYbASXCNk5zB1Pw6RI3XkM+Ywz5OIpRW6CcAhnxpG3abo6xBoLgd+XWYBBh0F42B92bD6fz/vcfe4rPRmEvWbwdnRy9v7i7ID2rGquVvuBcidRcUEMscwuKiDeX4fDw2f9p/0nbtRRxiK6Bh66sd52Yb0eyI0O8p++6Q7JYZGqDHCaF45FOFsvQ0nGueOpJ9hYlMM85MsymW5LYcYqOFU0Kl9FyyWxw486Xa3otb9nduUaMWII1HfFWw34fW/cN5rgjqp1ffHutuML3yYeDPxbr8+/AqVk1jWSa3rQLt198y3bCBnXb6JQy5u7upyx2Ylfn1FB5kVrxseCfuc6VfjRGLu5XDRkrzctD4H+bwzE7S3PKR2xd7yolvsvWzdUZd6vJgNdIyP5F+68R/s=
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: eJzlVttuGzcQ/ZUBnxJAWim2+2IEQX1rod4SRDb64BgwtTtaMaZIluRKVgW99Uv6af2SzpCra+I4BfrUIoixIjnDmcMzZ2YpKgylVy4qa8SpuJ4gvGu0hksZJaCpnFUmgtTazgPIvHwTlKlhiH6mSoRodyxkWVpf8TYtS4DgsFRjVebdSxVKbUPjEc5qjzhF8u2RTSCo2mAFowXECU4D6hnShaZaXwpD2/gSO4CKDnjasmYxtU3QC7AexvRfbq9TplIzVTVSFx+M6AiPvzUY4rmtFuJ0KUprIt3Nn9I5rUrJ+fc+BgZhKUJJIUj+iguHBIsdfcQykh/nrUMfFQberSiwbU6blN6njAbVjoMQPYFCDvbhfhqV7AMGl2LVEdtsvsbpYHM6ma9y9soj2d4+G/PdapVNgrMm5DyP+v2U7t41w6YsMYRxo+EsfcG1fUBD76lRBqSw/iWUZfKenD+ffBtKTKEQB0cITSBeSYY0JAol5qIXq1VO9aT/6h9xYhdN9N76C1txuun7cieau84zmW2tt3lRuWFN0ZG/Rzl1mtZO+v3VZ9x/BouNiTiXFRWBayI46eUU4zrhQ8BujGzixHr1O2XUEROUFXqOjo9+kx/+fwrNgO7zhsooJMJAuuYAIzIKWDZeRRKW26U4c+pH5M+7VWcpzlF69GcEcFrhrGUdGJ1U+T9L/4DRaVkiI0KhTCxhJ5wNCRHJdqI3O+7RC4xV3ePi7QZH53uONLfLvwVHwPGFFMCBwODUtuHTucZrWpvE6MJpr1fRXlc6VajaSxMLZQXHfFDlFDDL+RM+Qt4+dHO3RWXI5MhvusZm8zgyL7DAsc8EK/0y9Chcyi0vE9k+LfR3A3jABTB7iZstJwvgDjaTukGwY24lcL/n5x7yNTBtQmR1cB7H6pEUYk59hQ6nkOAeXhgbMTmIXiqdMGDgX1IHKuriwO0ptIavF6QxDEeXgntzX7B877JgKUbp13fWTyVVlPjh1+svi5iTIazDy57amInEsBcEbBBMFckY5svEptr43VJL4Np9v22KV+vq+Iqmtq2p/b60Xk8Na2zXwiHLJBykEIqZExrnrI/fbtmyeXD1/XZpn2a7DD3AamMEL/7648+XoHhMGc6xUmECVZpiHsuJNDWmaYJIzANCxiu0IwxJD6WBvoBB5HYRaEePu8HSaaS5BGiTKBYXndZejjRCSULHy1KHDt1ZqVpFEos5DUsY02XBalWBsxVELCfGaluTvBGBDDlgRkkwOAeNM9RMVxa4pIJyRIyLizz/NNESVfh4aemRlDQUcqJDSs9j3eiUT2BGSKCOrLkuKgqH45xKYyg3ApWUG6mn83Osa4woTRQ/KvqfYD6fzwuZtgvr615rG3o/DS6ufhleddmGXoNg0XuPB1yZlS0bZs26dlme8nsd9Y9OiuPiFduyzlF0O/FsJ8mrdvY8LI6dbvSfnVbbYo34GHvUHUgdV+3rLNumcCtmx3nCorbAEG0aA/eNTWsgHZ5wL6Hzy+WIprIbr1crXqbK96lN0dtInwidm9ZahrmXPLBai4uMd/eao+LjJK5JvA8mAW4e2YL1y8Uvnt1td+/eDlkDR+1wPk1dX3g558Gd/p6KD/SPftjEgdRL0vpSaCrsRtZ8PvtlbZOt0m67zEPqMu0HZ7beMoudKA8bTk6G/3JqnzV5zWQn3X+zOZ53njTYSHQ+zU/LE/ffE366iQ==
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: eJzlVs1uGzcQfpUBTwkgrRTbvRhBUNtxA/cPQe2gh8CAqd3RLmOKZEiuZFXQrU/SR8uTZIZcSStZaYtee7FX5Mzwm29mPnIlKgylVy4qa8S5+A1lFeCiLDEEeG+ViXBlzVTVrZdsAnYKsUGwvpZGhbRWiIHwGJw1AYM4X4mT8Zj/7Ud+K6OEX6R/xOi0LBEuZcD94AE8HU/RSmsimshBpHNalWl79ClwpJUIZYMzyV/OW4c+qnyuTLAT6mtTOf7/HMcdoc+GkCyg/Kf8CFBcOiTfEL0ytVivOeHPrfJYifOPR8+9X7NVQ/mgT+Cuck7DuxSqn0QXPGU3EPgkZ07zwrPUKeB+Lv2YkM8S6dyz8SuO/K957GeD3lt/ZStkMPz9tnfm/ZYLO/mEZSSb/RrsvHeZER9YE7Recmfj8fpI+J1PR3Wfj0tZgTKujeCklzOMOdv1M1o+GNnGxnr1B3I37YrApt/l5vyfUnND53kjNQT0c/SQjjngiJwClq1XcUlJr8SFUz8hf96vBytxidKjvyCC0wpnLevA7BwZaCaF0DSW6BM1Jk4ke4rR/HSUJ29UkTIMgyNNGOVJGqYRGuJmlhgPow0JzoGs4Mx2yZBd6zWtNTG6cD4aVbQ3lE4VqvbSxEJZwRnsB7gl+ETnt2KEvH0Y5n7H0S23Sq7whqltqWReGFCdOWae0IEwVCL6fdF16UZl9oFdvL+BR1wC9zJ1atehBbCAzaVucaNVD3txHjohgFkbIkwQnMepesIKFio2ZJwgwQO8MDZiChC9VDpxwEV4OQAs6uIg7Dl0jq+XtvVMx5DAvXkoWJX6PbESk/TrB+tnkuZL/Pj73fPcsgBH+4iGWjaEDbwcqcNMLQ17IGDLYJpP5jAftpNorlsSaGWmdjPoskyDThOtuLahdc76+P2untuSqHe7pf1G6PfQQTZbJ3jx5c+/XoIKIOF2gZUKDXB3Az6VjTQ13TymAmozNe3KmdpOlVwlO1eUWwE3EVq6SGlHT4fBkjWq2gBtUhPE5aDzlxONUJIw8bLUYUBnVqpWkYZ7IbXGmA4LVquKbroKIpaNsdrWJEdUYkMBuOYSDC5A4xw1NxQLUlItOaGeiMsUhFrQUjHZvLQkOUoagpwKltLzWLe6u8KpZhKmrdbcuRXBYZwzaQzlRqSS0iK9E7gcmymgpqMmPCnGzzhfLBaFTNsFXcijzjeMfr65uv719nrIPlQNokXvFQ94dipbtjMiZzNdLCC5Xifjk7PitHjFvs6GSOh6ePgJ9DcvoMNe7l0l//n11PVuxKc4oseRSld9omLV6eVHMT/NDyOKxhC2mkk/jqsmSVRDybHvajUhbf7g9XrNy59b9EnPiRTpUydldd8oFMvsIwtZGlTHCpwU5+ijpC/x76551mUnBDsRfEwi2H1w9M2WWfZiH+phhsB/WbaPurzmSpMsvdma551vOmwVJFsz1fxU+woGGNrB
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: eJzlVsFuGzcQ/ZXBXpoA0kqx3YsRBLVlN1CbBkVso4fAgOnd0S4jimRIrmRV0K1f0k/Ll2SGu5JWKwkI0GMv9orkPM7Mm3mcVZKjz5y0QRqdXCafUOQeroVHGBk9kUXlBG95cKhEwByCAQE3Igj4Q7gpBqtEhmnSSxx6SwfRJ5er5Gw45H/74F2rE/eInNAyowPqwCDCWiWzuD344hlplfisxJngL+uMRRdkfe8zIe4DHp6R+aFr4xu6Mywt0rcPTuoiWfci2oNTh8cfPn0AM4FQ4kEqfvIwwyByWj4GmSlJYY2PuDCKOzC+OYV8Gu4OM4fhJGS9/eOwaybzayUdkpufOV+7VLQi6Nz+uMUxz18wCwc4R7h5XPOhkihHF7kZ1bT37yNSm+cGOxZAL8EXMbOKFw6qgwA7WWhhQn1XEu+9GL5h5B8utXYw6JxxI5Nz+uL3TevOg1T0OiW4s95FJsmLglxrBXcxHK6PwO9sGsba+bgWOUhtqwBWOEGlWEe7PkjLgxZVKI2TfyNzuSOBj/5c9+//NDVjus9pocCjm6ODeE0nR2TkMaucDEsKepVcWfk78ufjurdKrlE4dFeU4LjCUYvCc3aOaB4nhbwpDaUvKTDmRLBlMpifD7J4dsCC0veWGnbAjdTP9iHYG/bVR2c6uosz04RC5yoWtKQMwfrLwSCnvb6wMpWFEzqk0iTs/z7AHTlPyTyF4evtLszjLkN3XCg1v5s8bYkS9UKPWGbMuj97iSaC6PdVU6MxzKRL1NWfY5jiEriSqU6b+kzhnnRuLlSFG9F72sN5amQAZpUP8IxgHU7kC71uCxlKOhxdgid4pU3ACBCckCrmgCl43QNMi7QDewmN4dulqRyno0/OvXtKWZPaFUHvVPz1q3EzQd2V/PbX/WFsWYbe03s7RU0F6/3GvRqp8ZkKGvacgG0GY3dyDuvLdjrPvEV1lnpiNm0ustjm1M+SufWVtcaFX3Z8bimR73dL+4XQrqFONFsjePXtn39fg/Q0RtwtMJe+BK5twJesFLpAEDoHKjM5aeiMZSczZsnMJcWWwjhARZMG7ahJ3xs6jbLQQJtUBGHZa+zFs0KgxykuC+V7dGcuCxmotRdCKXoU+TJvlMzBGhpuMCu1UaYgMSKKNQEw5wI0LkDhHBUXFMtR1CzxTDURlhGEStAQmXw8MyQ4UmhyORIWw3NYVKqZcYgzAZNKKa7cnNxhP2dCa4qNkko6izRIMR2bLqCioyI8S4cHOV8sFqmI26lxxaCx9YMP49Htx7vbPtsQG5QWtUcecO/kJqtmlJxNd7GA1HydDc8u0vP0Ddta4wN51/KHx8Rj01u3iFsvyH8ZLZu6DfgSBrQo4yNf1YNZrZSfk/l5PTUSMHuxVctmdunqJYlTSWGx5WrVDDfrNS9/rdBFHad0CBdrqFb1jTaxwE5ZwmKLWpbrqDVHh5G2tL+/5S4XjQTs5G8a5a/5YPTNll62sLtKWLvAf1mwj5q8ZY5JkN5tj9c7Jw222lGf5kTziPYd4Lw6Mg==
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: eJztW9ty2zgS/RUUX2JPSbR8SzKuqal17prZnaQiZ6dqY1cCkZCEmCI4BGhF49Lbfsl+2n7JdjfAO2XJudQ+jF5sigQaje7TVxK3Xih0kMrESBV7Z95bwUPNOHvGDfyROoiUzlLBzqepEHMRG/ZWBCoN4d+N1DDH93pewlM+F0ak2jt7f+vF8ANIhUCipFAQuBDzJOJG5ASGIVCQuHbCzQyu6wy9i+UfmWDDZ0xNOvjKqRX8AIFU/JHJVITemUkz0fN0MBNz7p3demaZIGfapDKeeqtVbxOzdrNfx6Kl8T34+jYibCj0Xoxe4WCdqFgLjc+PBgP8V19/aywxRB+sH6jYwGOkxJMkkgFHSgefNJK7rbCTpCoRqZF28TtlVeFejT+JwLTEdM5Sy04qEtgUzARDiCvcjoVZCBHnIhypLA0EDAnt73caZMJGIr2RcJuZGTcsAAJjwbScxiJk4yUbKzPrsTHX8BM2bGaCZQkwDj9fKgZyzQIDzPvsAp68Tkx/GLMbHoH6QjSwuYyFZouZgIkpzXY8S+A1MPLG8oOSKNaecVAlM4qGtzntWAqIqTha4i8ZsolK3SqaoWa4jHE67oQ2xpFh7V/WkfPek6RKHqsYFBgRRrd0CW6kFfAoX8LdJeYd79VnKjFDnGnkXGjD5wneS6c8lprgQwxUb7xVEc6T+pmIQLahB2CuA0qGbcyvMa6NGJch/JATKVLfW9XlsnENVFCQKq37Vf55VCFKWirxQGtsK+0OyzDSRILCQamRhrH8MBWxSGXwAyzpzHeuQhEB7hJCBLGjYQigCOHurFqTF4qXzJrxA81QoRFwrhaIRQCfpLkx0xnxg9g93AcJLBOjpilPZjIokUeAP9pnPAulAUoAxMv4XINo2CRVc+Li0tNZEAitVXrpASNRNo97YMcF53qmsihEcwEucS6aTKSCaxFigPvcj5Xpy7iPIkXj9c4mPNKiA/B2V7+h9+45eVrk0SXCBAeBVP4EsfwpwlHME1jduLv25iuuZzUobwlNAMGcg9/04Fp8homkxIenJ48Oj46OxOPgUXA8Hh8HR8HDh4PDllILPzx8hvipbGXrtVBABdJaC7xBgatMg2+5dORBH+PMWPiKYEY2AXrh4Ot1VS08ikAllxWmLmnlOJuj7JvrJgrCxtK5jGYouFpVVPNVYnx88uNRp7m++RVhjthTDsMYDhZcVyzCW9VgsTUjt77vrzpXra4lm0vZIPS7NCBU87q9/bECh8jjdcs6wNcXHcYhRmcydlgzFyptNBITiJkRj6+ZjFkH5DGOxajZIAN/hDGlbgF+SW/Ol+gNNFgbqBHgA5CYSIKEjMnZdZnUV0o0NwfhAuoeejHY2C+j17/t4wVnsHvjs3NIUpZ0mz3N/Towg2TYCPEqcDRYLxs+v3jB3r54yh4/enzqMzY0eUgFalFEgAF3HoU6h4/FOxOfA5EYkIH1YsOw1xBW9XcuAIzJq5Zf2Voq/HB8FByHJ+J08vCu65bgcBnkv0vne6NX5/3DfeSrdG9bs3Q0ODrpDw77h6cXh4Oz48HZYPCvtiXkdJEHwlju5xFjM0gpIXKFPgq/dDDD0Wv2GJwie3fxFNUtGLKHbPIMLCbFTTxZIt5vZJjlcbttDfYpetBeM1uuk3qNKdy9/M/J6ckhPxIPxaPThz8OBoPDk1M+hoS7jdsJxK8YklAInJAE8hDSRpZpyhjBSmcAxgBcLCadBuNtLh4CSx4oLWuf+5PrPsX1ejZwd8IynNQJozOKFQTUeOrSVkxAtCkG9OBqgo8Uk5AhFEwgR5CMh8L+vB9+t0NvcNwGEFAQaR9yGKkxZWEc4u4E8mubUSQuirlcqwcmnEiQJT1sGFud/zJf3XoTVVbBS30lr2xvAZWEih8Ydh2rBZPWyTRHUZyyNQvEZch9wF5Xq+6svGUFGIjK7AzSFjAJW/wUBYil4Zc4aiWe1cz+HtlXwpeRohpSVwgU189ge8AL3LoBNU1cYfkPqKZU8+abglLHXZefVZ+MSFxPlp23z3Xj9i8L/QpqXZE2CpaOGF1Yc5FEXqDM8h/l468pX0p9lSUFYddJYasSZWMNtEcx01LAJUIbM+1G9vMcZa2B1Ff85feLku3a3FzLGyt+N7Ak06sWuEHE5Vyj3wzLSqIUFKyPq3YAaSPr52whoqiPFhg7cUB5DyDHiwVUNzM2J1LoN3F9n/2TSnEqz/UZe3AtlmMJ0Saefvi0MA+ajLy5j9pKWrgn5lReSVitIwDXDPAKMwwrVUGsWXudq25GTCNSqGQhfaJykmJSvdCbuWQCF7XtCeCk6Kn0mPSFX3kII7sksVpjrRs5fCICDirAOFqaBhStMrb+mupeyE6DGYfgxtQNRjGw6B7ylFIvhbNYWAFqo1Lh0vPKfG5oAziN0iZgDgtZNrQNogBcnm3drSmBezbaUuKYpzQOyEyruWj2CSKlrlHdWYLuneSyxN8UCrIxVE4IiiIDtewAMFKz9Lslea43S/K5pKaVgxO5gkuKKB80hQOoBIGb6v0MOwMftO31tMo9N83VePXBVOJ1O9zN1hkRJqmZ5rpmbSPv1e5Rwot9iKZknHqm1JgD8xpVGyKuWtuDeuDR6eHp5pz4jjS35QnXRpGugm+Loq5MKtu1XaPRA0KgpK/hQXpQ4Sz4EnCKwZuAuDFilP3Fslim8LdROtghaNRQtj3VuadESexMGdWz+wFrIqtzQAwLFj/wnMUPNldqw/KOwZXOQ5dC1jrJhhvYtIzzB7aN5vr+lV5xQy9latfdWv2SBK/eYd7lebs8b5fn7fK8XZ63y/N2ed4uz9vlef+/PM++Jt8Mjt+/6TcG94W885L1Ln6lb1yGZ9wfD0NhX3k3XvhvtVApt+rsvIFNOx8LbF0jbtgeffdQG3ktRIJOWyXL/RYX9JXBVnykMLKTkxyphfrZnvCnfo9VvOO+f1+vWX73sIWnmDRwENqpvsVUuvuSYPclwe5Lgt2XBLsvCXZfEuy+JNh9SbD7kmD3JcFdXxKs2g3havpz94fclXzzikjNqOCnZOapzQz7ee3Y+nKdviGvuabmB+arplyqNJldy6a9J5D4AOWtv1avblGkqUqfgjUgM3j9rLLmVVs89ZytnF3uDApbMaVGc7G5k8Fg1UG+AzGlPJ5wDIQJJFLFqQ7SWEss7+LSB3lVJVjRnPyFRfNW2OIL8Q75aBa3BXRqD0r8RQWUt4PRx2EjlZZpyIjSjSBLpVnSqaLzRP4q8PIKj8c8ETwV6TkgkO7grvkUjx+tP22iUTZz17r3poJEg+dlzryDm+MDUMVETg/Q9/TLnku/KLoPbrc+0LQ6sN5v7ZT8WBEOtJM2DK3QtuXdTX7YqvmmY66cUGFclmKsnRmT6LODgxCe9XkifQmVb2x8qTyUZJ3ACMTo8ucuGto+bpK5KnVls1RCWq6xAjLc3nBnlWb5izF31OncuRMygXab4M2QmtXodLDJbS3FHl4p3ghgBPpYo/PReWw2zzSe4MEANZGfIRwtoHyBwcQS+8j2wFbtGw+TchmRDBIeiP0ew2ZLg+wZcxN/WoKlozj6wNzPH6mAqGLz1hvTrxd5SMbXSa29UY4CKcs1ZJgJ1zpnz1JyPGPtU2OCFRIkP0GJCk0osyrUG54n8/A1RO5wIKSTI5jDPtGQsyRRqflbqc9CJfJleasOhCqGGrspJrG9//77P/v2zchoIcCoZrb8gRLEvkVpttKZa1DlL5VTSq0h38QKNJr0Nb52EZBOuDcdZpn35/k4wjMygm5DfdmjkmoqDTiZBVb8hhbTCl+vJSq0LQIVqSm4RVBxDARQ5/gOZwEF542IEFDoGMl78jFgwiyJCEBQzW2ZGSiwfcmpXY4Ko+2lYkplKPYdJB4Xm2T44ovaSsTnnMcxngPqeeDxRazJFedWAKADEB75g5bMF4uFz+mxr9LpgZurD/4+fPr8t9HzPs5ZlR23Ug9oO6EKMvQnuXW55r2rhPxj/5AyTKUNcFfhB4/kbX8atAntSoT7sqOlDsdGfDYH4GUl5WckllvnvN97N5h3W/ft2jSdDhyend3nTGqap5vrZlUOh6bl/u8eXVkBnOYMxI07uL3FVuC7NFqt8PYfmUgp0oGaeErYtr5earwOu1soVVnvvXX5wj77ggO0nULPfXhMnz6gx7UFxjW6+Hsc9qWY8x02UlQH3477QsHfl+fvI/oW3lZXRa1EaLKzMfYkpkK3XRBV06aXzzF8cRfbyrh+TXHdXSD1Tp6bId6ygH9Rwp1TfkLnBZH252K4fbJ2QhEU7WiUIJaJ/wPQoSJ4
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: eJztW9ty2zgS/RUUX2JPSbR8SzKuqal1LjNRZjZJWc6mamNXApGQhDFFMARoRePS237Jftp+yXY3wDtlyZPZ2ofRi02RRKPRffpK4M4LhQ5SmRipYu/MuxA81IyzF9zAH6mDSOksFex8mgoxF7FhFyJQaeh7PS/hKZ8LI1LtnX2882L4ARRCGFkOLMZdinkScSMuxK3UMNcwBAoSp0y4mcF1nY/3sfySCTZ8wdSkg52cGsvJAYFUfMlkKkLvzKSZ6Hk6mIk5987uPLNMkDNtUhlPvdWqt4lZu8ZvY9HSeBBf1/iyTlSshcbnR4MB/qtPu0kzDFUI0wYqNnAXCfAkiWTAkcDBbxqp3FW4SFKViNRIO+e9Eqkwrca/icC0hHLOUstFKhJYC4wENMUVJsfCLISIc4GNVJYGAl4J7e/3GkTBRiK9lXCbmRk3LAACY8G0nMYiZOMlGysz67Ex1/BTxfCSYFkCjMPPnxUDcWaBAeZ9dglP3iamP4zZLY9AWSHCdS5jodliJmBgSqMdzxJ4DYy8tfygJIq5Zxw0yIyi19ucdkwFxFQcLfGXDNlEpW4WzVAzXMY4HFdCC+PIsPav6kD+6ElSJY9VDAqMCJFbGph70wp4lE/h7hLzjvfqM5WYIY40ci604fME76VTHktN8CEGqjcuVITjpH4hIpBt6AGG64CSYRvqa0xpI7RlCD/kRIrU91Z1uWycAxUUpErrfpV/HlWIkpZKPNAc20q7wzKMNJEgn1pqpGEs301FLFIZfAdT2pfYXIUiAtwlhAhiR8MrgCKEu7NqTT4nXjJrxo80Q4VGwLlaIBYBfJLGxkxnxA9i93AfJLBMjJqmPJnJoEQeAf5on/EslAYoARCv4nMNomGTVM2JiytPZ0EgtFbplQeMRNk87oEdF5zrmcqiEM0FuMSxaDKRCm4EhYuv/ViZvoz7KFI0Xu9swiMtOgBvV/UGfXTPydMijy4RJvgSSOV3EMvvIhzFPIHZjbtrb77ielaD8pbQBBDMOfhND67FVxhISnx8evLk8OjoSDwNngTH4/FxcBQ8fjw4bCk11zYEBsRPZSlbz4UCKpDWmuAdClxlGnzLlSMP+hhnxsJXBDOyCdALB1+vq2rhUQQquaowdUUzx9kcZd+cN1EQNpbOZTRDwfWqoppvEuPTk++POs313S8Ic8SechjGcLDgumIR3qoGi60ZufN9f9U5a3Uu2ZzKBqEP0oBQzdv28scKHCKP103rAF+fdBiHGJ3J2GHOXKi00EhMIGZGPL5hMmYdkMc4FqNmgwz8EcaUugX4Jb05X6I30GBtoEaAD0BiIgkSMiZn12VS3yjR3ByEC6h76MVgYa9Hb9/s4wVnsHrjs3NIUpZ0mz3P/Towg2TYCPEq8G2wXjZ8efkTu/jpOXv65Ompz9jQ5CEVqEURAQbceRTqHD4W70x8DURiQAbWiw3DXkNY1d+5ADAmr1p+ZWup8MPxUXAcnojTyeP7rluCw2mQ/y6d741enfcP95Gv0r1tzdLR4OikPzjsH55eHg7Ojgdng8E/25aQ00UeCGO5n0eMzSClhMgV+ij80sEMR2/ZU3CK7P3lc1S3YMgesskzsJgUF/FsiXi/lWGWx+22Ndin6EF7zSS5TuotpnAP8j8npyeH/Eg8Fk9OH38/GAwOT075GPLsNm4nEL9iSEIhcEISyENIG1mmKWMEK50BGANwsZh0Goy3uXgILHmgtKx97U9u+hTX69nA/QnLcFInjM4oVhBQ46lLWzEB0aZ4oQdXE3ykmIQMoWACOYJkPBT258Pwux16g+M2gICCSPuQw0iNKQvjEHcnkF/bjCJxUczlWj0w4USCLOlhw9jq/Jf56taLqLIKXuobeWV7C6gkVPzIsJtYLZi0Tqb5FsUpW7NAXIbcB+x1terOyltWgIGozM4gbQGTsMVPUYBYGn6Jo1biWc3sH5B9JXwZKaohdYVAcf0Clge8wK1bUNPEFZZ/h2pKNW++Kyh13HX5WfXJiMT1bNl5+1w3br9e6FdQ64q0UbB0xOjCmosk8hJllv8oH39L+VLqqywpCLtOCluVKBtroD2KmZYCThHamGkXsp/nKGsNpD7j6w+XJdu1sbmWN1b87sWSTK9a4AYRl3ONfjMsK4lSUDA/ztoBpI2sn7OFiKI+WmDsxAHlPYAcLxZQ3czYnEih38T5ffYPKsWpPNdn7NGNWI4lRJt4+um3hXnUZOTdQ9RW0sI1MafySsJqHQG4ZoBXmGFYqQpizdzrXHUzYhqRQiUL6ROVkxST6oXezCUTOKltTwAnRU+lx6Qv/MpDeLNLEqs11rqRw2ci4KACjKOlaUDRKmPrr6nuhew0mHEIbkzdYhQDi+4hTyn1UjiLhRWgNioVLj2vjOeGFoDDKG0C5rCQZUPbIArA5dlG3ZoSuGejLSWOeUrjgMy0motmnyBS6gbVnSXo3kkuS/xNoSAbQ+WEoCgyUMsOACM1S79bkud6syRfSmpaOTiRK7iiiPJJUziAShC4qd7PsDPwSdteT6vcc8NcjVd/mUq8boe72TojwiQ101zXrG3kvdo9SnixD9GUjFPPlBpzYF6jakPEVWt7UA88OT083ZwT35Pmtjzh2ijSVfBtUdSVSWW7tms0ekAIlPQ1PEgPKpwFXwJOMXgTEDdGjLK/WBbLFP42Sgc7BI0ayranOteUKImdKaN6dj1gTWR1DohhweInnrP4yeZKbVje83Kl89ClkLVOsuEGNk3j/IFto7kuf6VX3NBLmdp1t1b/SIJX7zDv8rxdnrfL83Z53i7P2+V5uzxvl+ft8rz/X55nP5NvBseHP3WPwUMh77xkvYtf6RuX4RnXx8NQ2E/ejQ/+W01Uyq06Om9g08rHAlvXiBu2R/seam/eCJGg01bJcr/FBe0y2IqPFN7s5CRHaqF+tif8qd9jFe+47z/Ua5b7HrbwFJMGDkI71LeYSnc7CXY7CXY7CXY7CXY7CXY7CXY7CXY7CXY7CXY7Ce7bSbBqN4Sr6c/9G7kr+eY1kZpRwU/JzHObGfbz2rG1YZ32kNdcU3OD+aoplypNZueyae8JJD5Aeevd6tUlijRV6XOwBmQGr19U5rxui6ees5Wjy5VBYSum1GguFncyGKw6yHcgppTHM46BMIFEqjgjQRprieV9XPogr6oEK5qTv7BoLoQtvhDvkI9mcVtAp/Z8xF9UQHk7GH0cNlJpmoaMKN0IslSaJZ3ROU/kLwIvr/EQzDPBU5GeAwLpDq6aT/Ewz/pDJhplM3ete28qSDR4OubMO7g9PgBVTOT0AH1Pv+y59Iui++Bu6+NBqwPr/dYOyQ/prGytdpufQ2p+tpgrJyF4L0sxcM6MSfTZwUEIz/o8kb6EMjY2vlQeiqVOYAQycclwFw1tHzfJXJeCtyknwSYXf6F/bm+4Y0az/CuXO5107nwD4bld878bUucZPQh2rC3s7UmUor2P4eRzjc5n537ZPNN4HAejzUR+hdiygFoEXiaW2Ge2B4ZnP1+YlMuIZJDwQOz3GHZOGmTPmBv4wxLMFsXRB+Z+/EzVQBVod96Yfv2Ux1f8NtRaGyUckH/cQLqYcK1z9iwlxzMWMjUmWCFBMnrKOmhAmSKh3vAImIffFHLvAfGZrHoO60SrzJJEpeZvpT4Llcify1t1IFQx1FhNMYjt/edf/963nzlGCwEWMrO1DNQT9pNIsy/OXLcp/0KcUp4MySOWk9Gkr/EbioDcwH22MMu82c7HER54EXQbisUe1UdTacBjLLB8NzSZVvitLFGhrfdVpKbg40DFMRBAneMHmQVUj7ciQkChlyNXyMeACbMkIgBBNbc1Y6DAkCWn3jcqjJaXiinVlNhEkHj2a5LhVyzqERGfcx7HeKin54H7FrEmv5pbAYAOQHjkD1oyXywWPqfHvkqnB26sPvh1+Pzlm9HLPo5Zle2zUg9oO6EKMvQjuXW5Trwra/xj/5DSRaUNcFfhB8/XbWzGNxFdiVIPOmPpUGvEV3MADlJSakVCuHN+96N3iymz9byuw9Lpe+HZ2UMOZ6b5QtaNKk5JgrObgZiQl7s77Me9T6PVCm9/yURK4QbEy1PCpPXRUuN12N3HqApr78IF7X32B86Edoov970x7T9AT2mz/Bt0zQ84v0qx4n+wkAJBfx73hapW10WuT4qwo9DdJqZCr53QV8P+zy/RY3PnzstQdkOhzF0g9U5em1HNsoB/UaCdQ35Ae4Xg8mPxun2ydkARB+zbKDksc/4LT/pr6Q==
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: eJzlWtty20YS/ZVZvEhKkRR1tcNKpVaW7JiJKlKJ0rpqLVV5CAzJiUAAmQFIMyq+7Zfsp+2X7OkZ3AGZVOw85cWmgJnunr6e7sGT4wntKhnFMgycgXMjuKcZZxc8xj9Su36oEyXY2VQJMRdBzG7FPPJ5LNiNWEiNXT2n40Rc8bmIhdLO4OOTE+APEPNApKCRk8goDD3slMQ14vEMv6ui3AXy90Sw4QULJy0SZVSwT4nfE6mE5wxilYiOo92ZmHNn8OTEq4gE0bGSwdRZrzvbypYd7tvImOvqRcI+0GIdhYEWmt4f9vv0X1WCFxiKkXEhgRsGMRYQLR5FvnQ50dr/TRPBp5JAkQojoWJp2W/QWOkE4fg34cYNZZ2xOBMpTGJfBgKeFjCeSzwW8VKIIFPkKEyUK7DEY/bBnYZi2EiohcTzeMZj5oLAWDAtp4Hw2HjFxmE8691XFf3RHvkziSRJA0bOjuPzYJrwKf1cwHWtfeKyd2Z//Ct/TVo4BzUV+r5QeJCLfy2UDL10yWjGyYo3gqzpkgI0hUmiolCL4tdFSUEkz3KS+G+4ljolcxZj+ziJhTZ288TVBMy9xGqXFmTch179ScWFW9+855pcOoKX4anxggsxkYGMs20coi+E89Cp+UKmz8LmXCm+Iv1CZbrFmxvOQOspau5uhpr+/3l09Wv38oKlpDVtgbEalJ4JwS3iQHr4U04kzLZOfeAl8ovPHIQEudNFeyiQnqrC3c6+JBmxYBMVzrNDE5vcKTeefDi6YqdH33cPWLaHkYuwXdGb9tiOCHZYqNiOXuzsEeHMxTfSJaHTxWSYeCb1Fuo1Oi1i5y+xG9v1EGQLRLrR2o707NHqYfoXHbHOPqVgZaglhs3ZEJzVlAdSm8AjF9CxjBHrHuNUgn0x5b6/Yh6FJB6SEuIVk8iPwYr9liipPZtaasnOMznO1Dm4E1ExsZwo39QyL4FSViPIFKpmZEfJGBXhF7HarESjMDc/MrNb2SP2rlP+LTTm/POlCKYopoOT/iaShsi6OMWLZTIba5FPimghNAnVnCOl4b3cSPfu5tIkqKo2v/a4GTmmLb01EEujwBRMJJLG1BShOtmVZjgOW86kOysVWHj5gvtwj/XzVWqj45ZXMzjuLFwigAQjgsRBg6jweuzqzegf7MrQwLMw8T2q1DvP8N1p1OwohDet7ozX1rydaNwIAjH4O6+7UxFOFY9w5hJhPNdQJZLjZWiBTovP55xe6hYfZgKZIg4ZQtQzWrC0SMEVmTc67s+l1bCbIZspVVt1MVXWPEG3VWbIujLafGSOwj5P5s7goM77PSw4p6TikePkbFNs9SgiU5ja1bvxYB+qZ8kAm3ESaI4o1w30UprkdCABtzEBk6GsjWSu7UJbAb5Qipx1K2DbnIyKv7biUcZ/LcRFQNazYFYBmTXhxqUhwMZEwSSAjSxrIHMzHnomKRgmPCdkkhpHqdKRcJF4rWENzgOMcmOUtSXBd0krkfpcVD3qIz93gzDuyqBLcuEY4DjhvhbVzJCWtrIEjZhuh455MDslPOecnhy/Ojg8PBSv3Vfu0Xh85B66r0/6BxtOibbvS4WundevTdntw8xDcvIdY0EJVMADtDv3htG9Q5juHkUBPxuoelsh3iW+b2prxhTZSy6kl3B/GyfORTTBKwKNhmEBbFISYByGvuDBcxKkRq1yGhWUiJNXUTaxgheJaahaoUn7QZEO0dW2nOo8JdXOSLth9AKbKttX105DNFjmtsaWdUYmW1W7us2w+eaS6o0B+pDdTfdloVxqBzf3DxeZQUElMDFok0UzQ7T0lN+AfDEWeY6P6VA3cqJVL+KVtrVt7tooNCC6IY9SFjPYV8/AFnZGDjMl47m++k+p7rpEjRXkiBEcLTiL5Kicazen7CvadT2spuhKncpP2LFNCGEQvuDS52Mf578e2iLTnM1oW4hVpvIWWdDLmNgpTcbq06LvpiIAnHG/YxkhNofb+8AQUQwLWKiisQSYVkNF6WDLlBmCM3aStQN0ANkgsQqXPXZLvZ40e1GeEotPEVEHe8xVqyjOQI6ZKXHiYyZQh3uMJx5UHkx798F9cKbRVNg+kKS4d3Ti4uA6VEjRqGnJPOigicslLxAwNXrYS0nBD93HlxQ+09jZU6V1xOrT9Hf2JxmDFkErf0AtfwhvFPAI3OP0qX2Yjn5iOQeWQx779gX09LSlgOajSFs6S0fZmlclTzQhHSk8TDQAxn1KHvZAurVwSLizAJ7uwy5cEyApmQXNNkxyXxLq3imhrjrfFOg3EpcbKs95WJdM83U45Pj7w9bxxfUvWayGqQ8ToFpyXYoIZ11xi60Feer1eutWrmVess7KTmE/yBhKja+ax/8zoGAIZEJ1X1uemVLNQX0xidnY58EjTUVaXJ4aqYAs6yY+p9Bl1QjoFfTmfEXZQCPaYEa4D1xiIo1LyKBngU4zpL5So1k4gInBBrvaDn9oFrpnp0DUEvbYGTV75jE750FofBjCmIw9In8VtBrRy4Zvb9+xm3fn7PWr1yc9xoZxhsVBDaiPHGYihe/pzH2svwOXu2j0oAObxYZep6as8t+ZAmjSvm7kla21wg/Gh+6RdyxOJqdf+v1sxW+z+e7o/Vn3wM4F8/S2tUiH/cPjbv+ge3Bye9AfHPUH/f6/m5GQ0SUZjI9leZ58bIbWHJXL65HyiwRD49rXSIrs7vaczI0GVtrpFk8QMYoO8WY1zJG4DZ1mNNi3lEE7tTPVSF0RdHlR/jk+OT7gh+JUvDo5/b7f7x8cn/Bxv9/itxPUL+pKUDjpCsebIwATbZASonQGZ3SRYgm3mNmqKoGvvFBa0T53J49dU9eraGADQppUCVMyCkIU1GCawjUa2Oo4X9DBrwm9CpkEQsiFSIGaJ+yfL/Pf7bzXPWo6ECgI1QWGkZogC+OouxPAUosoorSKQWYqJx2EcCSzsXMt2KryjzLQsv0hyqIiS32lrGx3KZgXBjsxewzCJZM2ydRXmTplL+0sYN5L26E6TqwMtjfcQJYQ54MhNkNjZu6kn5xziw27t+m1T+Pa1Vx/VpJT/W60cYdVpsksLwt8jwF9sluybS5ay4cUSoXqHPFAwtDvi+qYo66gKmordreNAPPDHff76xbybUOnXB9vOJXCCFAqv+03Nmuo5S4ospBTNoJVzfHfWDU3QttLbXg8EGkSNBV0Ym/5/6YKGoKfClDekOUWSNeGTU1HBnC4iTITp49PDlpfc1/18YG+73gjuBLqLKEbFzyhU/Opzm5tWxt4TbqBUDOanDtTYVRDn3sMnP3F0T5MMZHTfco+XS/f3s2vVfafNn7ost7PMtPGxcWIZW07tkX2VU19LjcPUy2ll3sDZxbHkR7s73t41+WR7Ek0s0HckzRmrxMYQS8pJG6joe3rOpmHQvkWeBrXyUxQjI/tg/TbmTQ3ZrNS5yzNDzy7z6l2/tdDukRklEXoVsO6PnXugq6vknxq+alC51Oagtk80fQtCdWcifyMCrNER4LFRiT2ie0i+OztQay49I0OIu6KvQ4zN+dVsgOWbvxhhdAldXQh3I+fTE9QdrYnZ2z+epdV2Z8/3DbPZmAHUMgjQGPEtc7Es5RSmamdqQjBcg2awDfYw2wogBLZjb5wgsYnYZZBuB0pIlVIsq1OoihU8T8Le+YmkT8Vj6qOUPah2mnyTWz3f//57x6BMM5GS4EomdmOBl3FjAOTmRkK3KwYNOn0Mx7koAWNQwxaBoSkptKfdHWI1QIIIb28jVeddL8ZPrkEefAYLWPHdElTGSNrLKmJjw0zjf7cY1Ho2a4/9MMp8hxMHICAmWSxQCzRQy6ETw5Fmc6kQz6GT8QrQwQuGM5t5+iGiE9pRvHGYOZ4SkxNZ0mjBLqYZ5OEruzNpMjIOedBgLNBqUjhIrC3UlkUwOnghIe9fkPny+Wyx83rXqim++levX85PH/76+htl/asiyFaYQeKHS90k3k2KnRKH36Y5qZ31DswoDHUMaQryUOfh73kw7+6c5eK1p/9jjD1ZfoWZh9vZVC6r7cZ+aOzIDhtc3I6fWnNyng32OYDRFWcZtP60vQbaXAGBZI8T080r7tT/npNj39PhDLFCIrnynirzd5S02+vfc5R1t3uTVrS99j230C2ai5LxgFlYpM6LfinTzS2+TzTFI2/UG7W7Pe+4QFK5lo/5N2AMYbdT8k4ikuUm5C/DAx+ekv5nKfJvih0j6bQpT+IeqvU9ZpnRbAfyzyz5QeKZpSeH/Pl9s2zG/IqYVeTDqkR+j9Pjlgr
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: eJzlWtty20YS/ZVZvEhKkRR1taNKpVaW7ISJKlKJ0rpqLVd5CAzJicABMgOQZlR82y/ZT9sv2dMzAIibTCpOnvIigQCmu6evp3vw5AXC+FrGiYyUd+bdCh4YxtklT/BHGj+MTKoFO59oIWZCJexOzOKQJ6LndbyYaz4TidDGO/vw5Cn8AI0Aa9dLi5X5wkGAlZKYxTyZ4roqwb2Sv6WCDS5ZNG4RJKeCdVr8lkotAu8s0anoeMafihn3zp68ZBmTICbRUk281eojvWziSBlh6Plhv0//qow3b5mRdsDYj1SC+0SCx3EofU4k9n81ROepJEeso1joRDquG/RSEjwa/Sr8pKGac5bkkkRpEkolYCrFeCHoSCQLIVSutmGUal/glYC5G/cG+mBDoecS95MpT5gPAiPBjJwoEbDRko2iZNp7UBX9fnBb/kwiSdKAlbPjhVxNUj6hyzmcgKTEs7Kd8x//Kh6TFi5ATUdhKDRuFOLfCC2jIHtlOOVkvFtBRvRJAYYcLtVxZMT66rKkIJJnMU7DN9xIk5E5T7B8lCbCWLsF4noM5kHqtEsv5NwHQf3OrZhLEvr5Jz9yQw4cw7lw13rBpRhLJZN8GYfoc+F97NR8Idfn2uZca74k/UJlpsWJG85A71OM3N8ODP3/aXj9S/fqkmWkDS2BsRqUngm4LdxfBvgpxxJmW2U+8BL5xWcOQoLc6bI9FEhPVeHupl+SjFiwsY5m+aaJTeGUG3c+GF6z06NvuwcsX8PIRdiu6E16bEeoHRZptmPmO3tEOHfxjXRJ6OxlMkwylWYL9VqdrmPnL7Eb2w0QZHNEutXajgzc1uph+hdtsc4+o+BkqCWGzdkQnPWEK2ls4JELmEQmiPWAcaphoZjwMFyygEISN0kJyZJJ5Ee1ZL+mWprApZZasgtsjrPVDO5EVGwspzq0lStIoZTlEDJFuhnZcTpCRfhZLDcr0SrML7bM3FL2iLWrjH8LjRn/fCXUBKXz7KS/iaQlslrv4sUy2YW1yCdFtBAaR3rGkdLwXG6ke397ZRNUVZtfu92cHDOO3mq1ahaYNROJpDGxRahOdmkYtsMWU+lPSwUWXj7nIdxj9XyV2ui45bcZHHcaLRBAghFB4mBAVAQ9dv1m+A92bWngXpSGAVXqnWf47jRqdhzBm5b31mtr3k40bgWBGPwu6u5ERBPNY+y5RBj3DVSJ5HgVOaDT4vMFp5e6xfupQKZIIoYQDawWHC1ScEXmjY77U+lt2M2SzZVqnLqYLmueoNsyN2RdGW0+MkNhn6Uz7+ygzvtHWHBGSSUgxynYZtjqUcS2MLWrd+PG3lf3kgM26yTQHFGuG+ilNMnpQAJuYwMmR1kbydy4F10F+EIp8latgG1zMlr/2opHGf+1EBeKrOfArAYya8KNK0uAjYiCTQAbWdZA5mY89ExSsEx4QcgmNY5SZWLhI/E6w1qcBxjlJyhrC4Lvkt5E6vNR9agj+9xVUdKVqktyYRvgOOahEdXMkJW2sgSNmG6HjkUweyU8552eHL86ODw8FK/9V/7RaHTkH/qvT/oHG3aJJu9Lha6d1y9N2d3N3EMK8h1rQQlUwBXanQfL6MEjTPeAooDLBqreVoh3aRja2pozRfaScxmkPNzGiQsRbfAKZdAwzIFNSgKMoigUXD0nQWbUKqfhmhJxCirKJlbwIjGJdCs0ad8o0iG62pZdXWSk2hkZP4pfYFPt+urabogGy93W2rLOyGarale3GTbfXlG9sUAfsvvZujyUS+3g5v7hMjcoqCgbgy5ZNDNES0/5J5BnObln+dgOdSMneutFvLK2ts1dG4UGRDfkUcpiFvuaKdjCzshhtmQ811f/IdXdlKixNTliBEdT57EclnPt5pR9TatuBtUUXalTxQ47rgkhDMLnXIZ8FGL/NwNXZJqzGeMKsc5V3iILehkbO4VZmtOibyZCAc7437CcEJvB7UNgiDiBBRxUMXgFmNZARdlgy5YZgjNukrUDdADZILGOFj12R72etGtRnlKHTxFRB3vM18s4yUGOnSlx4mMnUId7jKcBVK4mvQf1oM4NmgrXB5IUD55JfWzcRBopGjUtnakOmrhC8jUCpkYPaykphJH/+JLCZxs7t6usjjh92v7OXZIx6CVo5Xeo5XcRDBWPwT3J7rqb2egnkTNgOeSxP7+Anp62FNDc2lnpLG1la16VPNGEdKTwKDUAGA8ZedgD6dbBIeFPFTw9hF24IUBSMguabZjkoSTUg1dCXXW+GdBvJC4/0oH3cVUyzdfhkONvD1vHFzc/57EaZT5MgGrBTSkivFXFLbYW5KnX661auZZ5yTorN4V9LxMoNblubv+PgIIBkAnVfeN45kq1Gw3FOGGjkKtHmoq0uDw1Uoos66chp9Bl1QjorenN+JKygUG0wYxwH7jEWFqXkKrngE4zpL5So3k4gInFBrvGDX9oFrrnpkDUEvbYOTV79ja74CqyPgxhbMYekr8KehvRywZv796x23cX7PWr1yc9xgZJjsVBDaiPHGYsRRiY3H2cvwOX+2j0oAOXxQZBp6as8u9cATRpXzXyytZa4QejQ/8oOBYn49MvXT9b8dtsvjv88bx74OaCRXrbWqTD/uFxt3/QPTi5O+ifHfXP+v1/NyMhp0syWB/L8zz52BStOSpX0CPlrxMMjWtfIymy+7sLMjcaWOmmWzxFxGjaxJvloEDiLnSa0eCeUgbt1PZUI3VN0OVF+ef45PiAH4pT8erk9Nt+v39wfMJH/X6L345Rv6grQeGkI5xghgBMjUVKiNIpnNFHiiXcYmerugS+ikLpRPvcHT92bV2vooENCGlcJUzJSEUoqGqSwTUa2JqkeKGDqzE9ipgEQiiEyIBaINzPl/nvdt7rHzUdCBSE7gLDSEOQhXHU3TFgqUMUcVbFIDOVkw5COJb52LkWbFX5hzlo2X4TZVGRpb5SVra7ECyI1E7CHlW0YNIlmfpbtk65QzsHmPeydqiOEyuD7Q0nkCXE+dESm6Ixs6e7T96Fw4bdu+zYp3Haao8/K8mpfjbaOMMq02SOlwO+x4A++SnZNget5U0KrSN9gXggYej6sjrmqCuoitrWq9tGgMXmjvv9VQv5tqFToY83nEphDChVnJtbmzXUcq/WWcgrG8Gp5vhvrJpbYdyhNjweiDRVTQWduMP9v6mCBuCnFcobstwc6dqyqenIAg4/1Xbi9OHJQ+trz6s+AHU/eW8E10Kfp3Tigju0az4x+altawNvSDcQakqTc28irGro444zb39+tA9TjOVkn7JPNyiWd4tjlf2njZ+MrFzzNc8/NamP2GZRtuHsnO7MmyZJbM729wM86/JY9iT6UpX0JE3M6wSG2GKGbttoGPe4TubjWo8OQ1ovyLW5ngS7G9lHL1may8ee3nkW6jw/mqk28TcDOg9klBDogMJ5MTXhgk6i0mIA+alC51OWTdksNfRZCJWPsfyMYrFAc4GXrUjsE9tFHLmDgERzGVodxNwXex1mD8GrZM9YtvC7JaKQ1NGFcN9/svC+7DdP3sj+epcXzJ/e3zX3ZhEEAMUj8F/MjcnFc5QymakzqQjBCg3aGLYwwi5YYx6ym7eyx4vjKE8G3E0HEfWSbGvSOI508s+1PQuTyB/Wt6qOUPah2m6KRWz3f//57x7hKc6GCwGHn7rmBA3ClANe2XEI3Gw9MzLZFzlIJ3OabFjgCzRI/WE47poIbwsU++wcNll2svV2juQTesFtdH8d2/BMZIIEsKB+PLHMDFrtgMVR4Br4KIwmSFkwsQIBO5RiSizQDs5FSA5FSctmNj6CTyRLSwQuGM1cE+hHiEtpp+rWYHZ7Wkxsk0hTATpjZ+OUTt/t0MfKOeNKYW9QKrKxUO6AKY8COB2c8LDXb+h8sVj0uH3ci/RkP1tr9q8GF29/Gb7t0prVeh62tgPFThD56Syf+nmlbzhsn9I76h1Y/BeZBNKV5KEvvbb5ZqNxflCUnRd+Spd5Ln3Eso+bUpUO2l0q/eDNCQe7ZJqNTVrTKZ6dbf4GD8lrim0T3acnGpjd63C1otto4LWtBlAX19bHXM6Vhq6D9kFDeeu7t1lN3WPbf87XqoE8hSrKnzbhOfRN30hs86Xh6mOBYu0e3DrKPHFSotiEquWC9sNbSl48y2zrrP5os3p2QdRbpa0neCeC+8jjmSXfkesiz35fvO6ePLugSInubdIdAfj/A8J1nG4=
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."
sidebar_label: "Read OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u20YQfpUBTzYgUYrtXoQgqGO7hvqTFLaCHgwBXpEjcuMVl9ldSlYF3vokfbQ+SWeWFEWKTuH0mpO4f9/8fzPaBTHayMjcSZ0Fk+AORWxBwLVwAn4T5gldrkSEYFAJhzF8vCxcegZXSmLmwmAQ5MKIFTo0Npg87IKMFoQT+fNpTBck4+bCpfRt8EshDcbBxJkCB4GNUlyJYLIL3Dbnd9YZmSVBWc75ss11ZtHy+dl4zD9dbV+nJe0KViTSmaMlw4g8VzISDDP6bBlr19IlNzpH42QlWQvGqqBamurFZ4wcO6BzuzG8p+z0GvQSXIpd7QjhyPZBDXKPkUHXB6r2vxHsg4/LMRTvfiPQdRugF5DD6tWwiRGZm9Gu7ePd8hn4QxBK6Q3FdqnN64CdXKF1YpX3cWf7oxe1BPKvqGwwoIR1sNKxXNYJcxAlSW5ZtrP6oZ34nSh24tAxuq3onOGOE4zgZVHDd5KRbtP1lLLbV98uuKoyfDjzCLt+eflcHwT4TMIUb/QKgQC7rmpjQiUr8HIvxm98wr+2qtpeQmO0udIxu8J/t7Nq3ndBt8YOrw+WUSwwIdVaxl2Mx+UL8D2yafvjvYhBZnnhoOE1trbsueVTxpHQRv6JHOtDECrXXHzHrrlDqwtDbJxpR9VaZH0H/VCx+XfqoCnJM5lQYNGs0YAXc+QjemQxKox0W99X36MwaJilaDnn9uhEwi2XxFoEqtKlTArjHWjZDSQ/1eSwIPHs4xvwJBitz0eRvzuKqXkObU5tc1SxyrBiqNFuz2FlwEqwilVvP+b6la4toHuFUbSXOpfbyWgU09lQ5DKUnuhCqYlYen2MLCAffg3DVsfHMPODY+45P6qwXubyF9y24iOqjXr8qHlrsB9PLuva3RN6V7HL36fwhFtgr5Aj6rQMYUaNYi1U0bTMxw7OY02PsCqoZSwQcoNL+UwtayNdSpe9SvAIJ1QY6AGcEVJ5H3AcTgeAYRIewU6gfvh2S2XF7hiScu8eQ+bqdlrsgoVf/aTNSlBRBT//MevbFkVoLTj9hBnlqbV79SqkWmfKY+goAY0HfVGyDythh27IcfPtUGZLva9uEfnqpjKWHFtb5Lk27sdDPJuQyNvDVjcR2jl0ZE3zCE7++evvU5A8u97TlCBtCpzggM9RKrIEQWQxUJo1bdynnYw4SnotybYQpg4KGjfpRC2HVtNtlEkGdEhJ4LaD+r1YKOQRwW8LZQckM5aJdFTRG5pSaDZjYVYrGUOuY3AYpZlWOiEOohBnBMAxF5DhBhSuUXFCMQt5qhILygm39SCUgpqCydcjTTwjRUYq+4B58wwmhaqKnmMmYFkoxZkbkzqs50pkGdlGTiV6RZqmORz7KqCkoyQ8C8c9n282m1D441CbZFS/taNfp1c3H+5vhvzGj1hOdYIHXDuxjooVOWdfXUwgVbzOxmcX4Xn4ht/m2jrSrqUP//moJ7FwfBjs4i4BN03jf/xZqVPV4bMb0VXp5x1v+a5myIdgfV79VyCOZOENS9Kiw5O0njTTHrFSSvbw+91uQYz8yaiy5O0vBRqmcPpcC+OTpyJTafmbGHpJOYT/YebJXd39TuFrJuxJL2PG8xRFK/p8Yk48zKTlvJkXvQ7VMVNC7loP+0Nhu5/c3jCriJpyaskNGdQfjP6iUm9rnpkxAb1rVPR8xPqV5b9CrBAt
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.

## 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: eJzlV82O2zYQfpUBTwlgy85mezGCoE42DdwWRbHeoIdggeVKY5lZmVRJyl7X8K1P0kfrk3SGlGTZcoINmlty2Mj8+TjzzczH4U5k6FKrSq+MFhNxjTJzIMGVmKqFSuH3qijgSnoJ15gamyViIEpp5Qo9WicmH3cnCLMrMAvwS+xthXv0G0RN8GF0biqbIkidxd8fnNI5zNGuVYp0jGK4UvolfWs6kH8RJK+NgLOMZiz+WSmLmZh4W+FAuHSJKykmO+G3Je9x3hKu2O9vebErjXboeP5iPOb/js3vGW2JETomNdqj9rxBlmWhUskbRp8c79p1Ti2tKdF6Fc84Nrhjlbn/hKkn4FP+w6HEoOzwxz6i49XH6CrrO/Dt+D/hj0ylVVfKpYVxlcVpbhFXxMkNrspCerzGtXJkxOyLVoWjDijQwkCDAw0QrZceMlwojQ74dNhIB8wpZiBzqXQg5amGRhr+r5k1meeN5K2yXdoQ3gJ+NeXaaJro2XlNCGZVbCFHjZY4yyCuPAORUgbTgqnvw9yoFaWVXJWfTZmwmRe3wIqKgFC9eUB9BpFApmmKzsENr4DKkW0LY0PU2FmOTd/MfbeQP3Jif026PT3iDaNdWhpnbvf8byCWVPFB23bibaz64U2wdtcXl1D/A4GPRGLBAz1x2J+WeBcT4lkinHs5fsHIT1aaLmForbFvTcaehe+rzpm3g57qHOvIYffBM4oz5mRax7nL8Xh/Br4ntV0+3sgMlC4rD+2tIWqej2n5oGXll8aqv5DDdAhCpObyO6bmGl3UDW081VKl+wT9EO+y75SgGZ1ntSzAkZKihXDMCUe0yWFaWeW3oWuZluoX5M/b/WAn3qC0aKeUgWGEvZY5tzdirnJNEtZKimNKyJalIfJEjoERblImYrR+OaIILFQ+Yj0aulKmOGLhG4bfNqjRaHfaxewF28aWn2uornBlasdoXWULGlt6X7rJaJTR3FCWKlG5ldonygj25hhgTq6w8n4Gw8XpU5jbA19zTpsY7Ya1NmwyDtTdWi1nbb82rUu6uUOODZv+PoMH3AIXPjFbZ2sCfImsZVFhcy3dHeHc1aoJq8rxHQulpdv3kYK0UX5Ji4NJcAfPqF4wAHgrVbh9QkieDwCTPDmBnUC98dWWqo3pGJJxr+8SlvBufuzEffj1k7ErSbUmfv7jpu9bvATDzULp61xjXkSqbab0hiMjoGUw1CpzGA87XJkct3BhKr0wTdHLNBQ9Vbfi2LqqLI31Px7i2YZEvT8MHSdCN4dOvGk3wbN///7nOSh+I8w3mCm3jI0ZPqZLqfPY21Ca8eMheuRid0Mem7Ui3xKYeW4LHM0Ui6EztBqpyIAmKQn8dlDvl/cFcgMShmXhBnRmpnLlqdA3knpAHw5zplAZlCYDj+lSm8LkJE0UYk0AHHMJGjdQ4BoLTigWp6Bg8p5ywm8DCKWgoWDy8tSQ/ChJXUIMWBY78Lwqgj+OYyZhQTXMmZuROWznSmrqxPh1RKqL9MTgcDRVQElHSXiRjHucbzabRIbpxNh8VO91o19nb9/9Nn835D3cbSlfHAUPuHYyk1YsSU11sYDEeF2MLy6Tl8kL3lsa58m6jj38yOu1eqcZ3LlMnvYqrNPT46MfUYOmQusTvN3VAvlRrF/GpxRJZN20RZFkDT2RSRqa9J57JEpLcoehdrt76fCDLfZ7HqYHkg1qTjRIG3Inaqly/E1avaAUwi84+ey6vhOfwzd/Qx2T0kinZt0MQke/6POBlbX/xt3ftk1pcCkuY4EpfQeg33l2L6r371ijZC1gB/F+COJdfzD6WeNOdTyawH/5ujm75RVnKMnp63Z5nPnshlb54mqmijvy/wDSr8xU
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: eJzlWMty2zYU/RUMV/aMXnHcLjSZTB3bSdSmbcZW2oXtGcPklYSYBBgAlKxqtOuX9NP6Jb0XAClSD0vJTFfZ2BSJ+8B9nHuARZSAibXIrVAy6kdXwBPDODM5xGIkYvYHT0XCLbCzOAZj2BXESiedqBXlXPMMLGgT9W8Wa3oGF0yNmJ3ADgUoL2hdzu0EnyVqwl/TsNYv9SsHtFbDl0JoSKK+1QW0IhNPIONRfxHZeU6Sxmohx9FyeUeLTa6kAUPfT3o9+tf0brtPTOPm0VispAVpSYzneSpiTmLdz4ZkFzXbuVY5aCu8pW3O1zxUD58htqh+PeDONAaLS8a9O1Y9gmRBHy7DTwnjhZ0oLUx4Yy1kOalrOiGSzaCsm/wkxZcCmEhwk5hj0GyktMtVzaT2/i997MFYSC645RfCxKkyhYazsQbIUEWVpr2GV0VBqthKF6uUlanAHEgMFyQYDCdRD82GV+cpN4bKlXtL+xxx5uOGEKsUsiPojDstdhvlQtxG9MClkvNMFeY2OmZCbjrUikAWGfYByeCvSiC6q/t6+YTtInk6SIbOv31+0ioKGQQ5hhGs+alkOne5+zgYrG3nONpud7/Ny5otrAcslK+wWKWtSuggMfub4L1KEXUoqhXuaJgKQ3lBN8ry1AfURotxw2aQpvSfPq5W7y66IfZSSnhwVbNKTUcKCpmATucYK6+hXqvV6s6t3OjF5Ll+KWW/rm+q8OxtoMo3EvOAMsOIaEiBGwwGxpQStsPHMiD/m5ebEbcTbutZJm+NGMumr7UofotnB+TS+ZHASEjwBURmqdIecGMTjkMIn+wMQK6Q7FoVOgZXMe73J0MWrkFPRQw4lFa9uL8XhqgUcX4sqAcbgOwVrFeZL/6hg6H9gILKf/5zWM49J+V3TOEuJ5iD/Ym1+a+AM+eAAJPa98PhR5Y5gZXGCjpIo5v1B+k6+zhgtHqromWdDtw09t/wOhj0AOwZAVlXEn4fOcbyfB6uC6d4VKQ7x3KltunRFDSNVfIg2RxORHwSMRVJwVPjrMYqgQRXicyNi32OveUixSL8dqeQ5hCVuSOutBn7LarYkfHBwMJkIzSPvezg3ooMk8KzvJZWgeRpDBrtYNtm3PpXP55uoyFPrNLAZpPQUTUHVBwXWm9JuihJ4UHE5Hm2sGtqrXq2VkD1Pd8tl661J0gbHQteROeeOrbL8b7BUx2JRLbwhApSerHBMJfrcarrZN6Wh5TT3gvSfDBdrQcQtFb6HAuPnKHni5pNrIv1Emxizkp6W96rzZ32esst6rdAwCoeb3iCDCsvLKvOF1GI83r5BEb8lyvqVRJ8aE6/49BcgfEDSSqLwxOH3kaAfvDHou80QAMZOK7BEY3nH2dmLUYoZADhR9i5mxZnufgF6NFB9BtAJqDPCppoNw5JLR/TQTgKo/WDwp/4OgsjNBqDLUdSP+pOX3Yx9iMx7tKIaJucx9At52/bY3vbM6HuYvuxeBmRh+T/tgP4BWQqbA/XFTrFdzQcTb/bTfBbm+eiI8aaS9sRKqI9rc0/3BCxmB06jP+8ruZuFbVrKh6f8zJ2VfK4fxEuAQKoVdcAZ6GxS3xuOkbk4BHm7kBMJ1hfsx0WhlcBJdm7b+i5D9jJssJYInO5RpL3hJN0JpBp3Hsf2T07wq4BT5s1zjoXA0rPcYvRwXBNbZ8FwVdz7DkKRxude33fISCvV8kienC/3pZTEXnY5t7qQz3HMVW65zUFn+kI2nCCVRF0HUsx9Maiqhspb26MCjlSZevz2LU+9rig3Joiz5W2P63yWaVEvFu9ahZCvYbWdlMJsaN///4HT850s3Q9g0SYiafV8BRPuBx76uwpSjiOG0+ecccKuRLoDhtYVhjk5AbSUdsoXA14PAjXGHbeCvL8IcVDH0IVvUaKhQdCliCdttjuM56mYJ0xo7CnWE5kFeKJVKkaI0BhiiUqoJxzJmHGUphCSgVFEOVwjD9gTdh5eSejMJm0PFYIQoJLdNklzG1Pw7hI3X4M5YwzZJMpVW6C7pCfGUfmoek2DbEXAkMtuwCLDovwpNPbiPlsNutw97mj9LgbZE33w+D88rfryzbJOHpm00byHLFOVFwQxym7iwDE5+ukd3Laedl54ci6Mha9q/lDV4O7b/OSJkhXg+VrbhRDqVp4sl08HQpHhtzOFwE4kce+9IQNoTPwaw+etJGt8Ikf+jvuFRGsJorOZDfRYvGAx+JPOl0u6TXyPu2wnrRqV1MeY4WhZ8TzEZYWPLPto6swMY/ZAXehW3deYqWc+80V9AsfHwlKd92VLu8qRuo89otpkbstLNVs0s76rHp3SdDEi8Z5DaHt0WF2eKgdoZoursO3d4H+1g43TZFXVJiIoq/r28MvOwUqwPOrKWBEx/8DZGUH4A==
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: eJztV9tu4zYQ/RWCL90FbNmbpC/GYtHcWrjdLhabBH1IA4SWxjI3NMmSlB3X8Fu/pJ/WL+kMKVuy7BTt9rGFAUPiZThz5szhaM0L8LmTNkij+Yjf2UIE8OxCeGCXRk9lWTlBk545UDhXsGCYYFciCPajcE8QrBI5ZLzHHfxSgQ8Xpljx0ZrnRgfQgR6FtUrm0c7gs6eT1tznM5gLerLOWHBBgqe3CR595xQ9dnz79J6ZKQszODj9K8/mEAT6LtCPsLKA631wUpd80+O5kujIuDi0eRln2PjqJcsvm7uB3EF40WSa/vtmNwk/6QDdvN+h0HK+c/DDzoSZfIY8oIlkxFvMVsLyZDg8dLDry9FkV5EI8dAvT+O+zcM18khGxlfHIP+fFEQKSfn4ImYckquTm4dInhmIAlzMzWVKe/82WmrnubYdCdDj8CzmVtHAATvQYAeFlk2WzuLx3LPhm3+kGO1gwDnjLk1B8MXnq9aZB1D0OhRsdjeRSfSiRNdawZ0Nh5sj5ps9dcbaeFyIgkltq8CscAKpmKLdHMByp0UVZsbJX2PBNUmgpV+nEv6PQjPG85wWinlwC3AsHtPBCDd5yCsnA14792t+buUPQI8Pm96aX4Bw4M4R4DhCUYvSEzpHZI9AQW9mBuHj6B5hImgnHyxOB3lcOyBB6XuLBTugQurn+ybIG/LVR2c60gtzU4eC6yoSND4LwfrRYFDgXF9YmcnSCR0yaTj5v2/gBp1HMF+y4dN018xDg9ANESXld4vTLlEiDfQwy2Qz1WePa0wQvp/XHI1h8m6izj+O2ROsGDEZeVrzM2O3qHMLoSrYit7jnp3HWgbYvPKBTYBZB1P5jF3GUoYZLo4usUf2SpsA0UBwQqqIAaXgdY9BVmYdsyNWb3y7MpUjOPro3LvHjDSpzQi8p+Lbt8bNBVYX//6n28PY8hy8x77nCTQS1vute8lS7TMSmu05wXYIxuokDNNhjc5T3qI6Ux1/atqn622ltNqhpo6am6s7tr1+WveS1FOzFRCRRwFBpZDRYGWtceGbhim7ZMvvmqF9irXZ2cFpt4m9+uO3318z6bFRvFlCIf2MUdUweM5nQpfAhC4YElhOa6JEQsuc8m8WElHL2DiwCtsYnFHTvje4GmSpGU4ivcKqV+8XEwUMo47DQvkenlnIUgYUjaVQCq9bOswbJQtmDbavkM+0UaZEmUPyaDRAbBJMw5IpWIAiqpLQRTUUE2RbWEUjSG6DNKHlucEESaHR5UiFGJ6DslJ1A4VsEGxaKUU1UaA75OdcaI2xIaio4IBdGqVjW19IZ6T3STY8wHy5XGYiTmfGlYN6rx+8H19ef7i57tMezAbCovaSx6gqC5NXcwRnW7ckTSlfJ8OTs+w0e0N7rfEBvWv5kz4FjjWH3QJp3U7/7gOirooAz2GAgzK2EFVq+5IO3/PFaepJ0TD5sdPiujPqqjFK3wxDo53rdV1Lmw0NY7G5eEsgJMJFHqU7Y6t8JN9PJJD7vRAtRz073vBsd5Bk2PCXa9tXzcc7Up1J/eE0j3cud2JJH1X4P+I/4w9fjN110nF8zRWWUyXKXUMWr0NRa1uj609R1+sHCmw7pVctJ7sSn2Khf4rs6Ja3RDFU2ne75WnmxQ07UUyrKcfUe/4JSEwPNg==
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: eJztW9ty2zgS/RUsX2xvSbJ8TcY1O7WOnexoJjV2Wfamau1UBSIhCWOK5BCkFI1Lb/sl+2n7JXsaAO+0JW8u8zB5sUUSbHQ3+nK6AT44nlBuLKNEhoFz4txEHk+EYpyd8wR/pHL9UKWxYKeTWIiZCBJ2LWaRj1E9dsnjRHKfpdlbGKfSKArjRHg9xgZjFqUjX6qpDCZsW4mEcTeRc/G3JE7FTgdP4yhUosOyX6zETofxwGM+X4xTn424korNUpUwIZOpiNlIsCgO59ITHgtjxv1YcG9pbgtFjI7jcMYwlnkxHydsLmIFsoYvd8qDCXFFz7WsuYCY1/dxH5dsLIXv2XnLE24PzsF0LOaSSDK6ImbzG1Oupju9u8DpOBGP+UwkmNw5uX1wAlxA0VAYL7Sbz53pduDhTUkrEvFkit+1ZQrkb6nAtCwct6xVRgXvxeK3VMbCc05I5R1HuVMx487Jg5MsI2JEJTHU4KxW781goZJXobekEW4YJOCJfvIo8qXLafrdXxXx8FAiBbVEAqYgFF2tEU0PqUjzxih5MZXulLk8IE0bk/KYDDayRUhq5QlHvwo3oWuZ+HTjfA07nRr7Pgwj5RPR1FF9FQbDC3Z88F13j2XvMDf0BNsWvUmPbYlgiwxzS823dvCu+MgxI5ETgbPqaDWdQcNx6PsiLs2WS1Cd7TQAtQkPpNLLgKkCBRlT0hInj/XFBIa7hAuNZYCbEFImS63BYMl+TWOpPOlqamW7uHU8SdamDbPjaCra/NLY10bowfjj5RA8hbHzvq4u7eDuz2K5Xl96Gd1cZBMbXHaPd1d2/hYaM/7xrQgm8IKTo/46kprIqpDi2TzpFxl8HMqD88dEjBTRQmgcxjMO78BzuZbuzdVbIlXT5qeKm5FjytBbrTAHz0z8UsQyLOtAwp8nkAmzyEDO0plzstecYqkYRLPuSOExJ8gQgufc1+aSm/PB8ZG15uGUkxBXgoTRhqbWm3V5NKPIGS5MzCZRMZ8CUUomF6+Gf2EXmgbuhanvUZjYemTerbu6kUchbG15o2265gtE40pQqMO1VVrHmYhwEvMIWigRxn0FRcPV34YmHLZ4RD7Tc43mHfKaYEmItINkQlowtMhyKjyvNeufSqOxkppsplRl1IVkVdI8BfhlFpbqynieBf2IFZxRyPHIlPJpbWC/F1FC87Srd61g76qyWKLGSKA5olxfoOfSJKMDCZiNdieLTNb46l6/4axX1vqYHJdhT4elgS+UymFKhlza4YpTsHBeJr8mcnxBbgwie0WArI0NEZBV3Gr0EGMmcpAvxQql24sxsqiXusmz3Q0xmZxN52zgKNeSsU6QI4VN0ohBYsQjqASIUZCujiohrQxcPwV+7BhEaeFkGUdqGEnoscHGlR30edhhGbmn+Kq9YrmrgNxH2fyRHq5llEZ9DVYH59qPjGHpsHBOKEkmn6DQyxI1VpCjiYxVl8iOwtAXPGjQvTTlEQlGLkARZ9WEshWwtgbOvjckwFuEuG4y0n6/30Td60F1BsKdzhcsBdaAXpZkzIRp4gPXIlUFJUQyEslCiLxIGIZp7Aq99ubGjaJUNxTxXLoU43mS5ww5IZQ8QskYJtNeAzBokT8SSxrvaD47RXXQcbI4hGflqi27+Gf+uIb0mwjtcfhUpJ/WLFANxtYTE7w+QlmgnHqAbAa2x2PMU279hCfltt+ARZk+izXnccyXpF+orCWVrBrGQOPJD2+uBor+/zS8+KX79pxZ0koj7A282ZbPG3hAtRAwVJ/Bfw6Sbx8rQ5vZ8Xr6FGc0hUmImT5XnS9Usq4KE19Ll5i2g02gBIjaoGpfVXzni6wb2/bgZHN4utbalvSMaHU3/UIi1qe3FAwP31oA31oAf1gL4Mmyv6Xk/1bkfyvy/4xFfh2wm30KWw08mgA2L9trflhcbTTHJxfjb8v7KxQA1k5ZA5nr8dAjQUFPwnNCOqhxpCoVCReB1yysxnmAUW6CtLYg+C5pJEIf1WA9EP3YDcKkK4Mu8QUxMOOY+0pUI4NNbWUOGj7dDh1zZ6708I+PDl/s7e/vi5fuC/dgNDpw992XR/29NVLaQvSxRNc+1y9N3s3NzEJy8h29ghKogAcod+70RHcOYbo7JAX8bKDqTZl4k/q+zq3ZpIheEqV3yv1NjDhnUTuvCBQKhjmwSWuN3MqBXdTqTMOCEs3kVZStO0TAYJMwboUm7YIiHKKqbZHqzJJqn0i5YfSMNaXOVmOGIdFgmdnqtaxPpKPV2rbXH9jn+lp9q6/ZeHpWSweJRu9PPxlHKYrZrXGzfY0Y9lU7VDC04DSSw3KsXR+yL+ity0E1RFfyVKnfqYsQwiB8zqXPRz7kvxyYJNPszSjH9q2sylt4yXZ082Vpdov+OhEB4Iz716L1N4PZ+8AQUYIVMFBFYQgwrYKKbGNLpxmCM6aTtQV0AN7AcRwueuyaaj2p30V6Sg0+hUft7TA3XkZJBnJ0T4nTPLoDtb/DeOpB5cGkdxfcBaeKOpV5N/vOUakLwVUYI0Qjp6UzOvNQcF4gYCr08C4FBT9075+T+HRhZ6SyecToU9d35ictBg2CVn6HWn4X3jDgEWZP7F1z07Z+EjkDlkMc+/wJ9Pi4JYFeVXu4JVE2nqsSJ5qQjhQepgoA486Sx3og3Bo4JNxpAEv3sS5cESApLQuKbSzJXYmpO6eEuurzWqDfCFxuGHvO+1VpaT4Nhxx+t9/avrj8OfPV0NowAaoFVyWPcFYVs9iYkYder7dqnbU8l6xPZbqw72QCpSYXTfH/H1AwADJx9YEkPWemVC2oL8YJG/k8uKeuSIvJUyEV0Mq6qc/JdVnVA3oFvRlfUjRQdGomIHw6ogND2iRk0DNAp+lSn6jRzB0wicYG28o0f6gXumO6QFQS9tgpFXv6NjvjQahtGMzoiD0kexU0Gt7LBq+v37CrN2fs5YuXR3Q8KsmwuLJHofKDUNZ8jL0Dl7so9KADE8UGXqemrPJ1pgDqtK8acWVjrfC90b574B2Ko/HxU78fzfhta749/PG0u2f6gnl425il/f7+Ybe/1907ut7rnxz0T/r9fzU9IaNLPGgby+I82dgUpTkyl9cj5RcBhtq1LxEU2c31GS03Clhpuls8hcfEJMSr5SBH4sZ1mt5gnlIE7dRkqpG6IOjyrPhzeHS4x/fFsXhxdPxdv9/fOzzio36/xW7HyF9UlSBx0haON4MDpkojJXjpFMboIsQSbtG91bgEvvJEaVj72B3fd3Ver6KBNQhpXCVMwSgIkVCDiYVr1LBVST6gg19jehQyCYSQM2GBmifM5fPsdzPrdQ+aBgQKIu4Cw0iV6O1x5N0xYKlBFJHNYuCZ0kkHLhzJrO1cc7Yq/8MMtGwuRJlVRKlP5JVtLwTzwmArYfdBuNCboVPRGKXzlNm0M4B55zNsl5YQ53tNbIrCTJ/VfHDODDbsXtttn8bZSb39WQlO9b3Rxh5WmSYzcxngewjo85wzl2UhRRyH8Rn8gZih3+fVNkddQVXUVrzd1gLMhTvs91ct5NuaTrk+XnFKhRGgVH4KVq9ZQy03QRGFnPIiGNUc/olVcyWU2dSGxQORpkFTQUdmf/9PqqAB5osDpDdEuTnCtZ6mpiMNONw01h2n2wcHpa/er7oF6n5wXgkei/g0pR0X3CGp+URlu7atBbwi3YCpKXXOHXBJqqGj2ifO7vxgF0sxlpNdij5dL3+9m2+r7D6sPQC+MsXXPDs4Xm+xzUIrsN2nO3GmSRKpk91dD8+6PJI9ibo0SHqSOuZ1AkOIaNFtGw1lHtfJvC/0aDCktoJMm0Un2NywR9htmMvans6pdXWebc1Ui/jLAe0HMgoItEFhrJiKcEE7UWnegPxQofPBRtPSWX0xlh+RLBYoLjBYs8Q+sG34kdkISGIufa2DiLv0OYLeBK+SPWH2xe+X8EJSRxfM/fBBw/uy3Tw4I331JkuYP727bsqmEQQAxT3wX8SVytgzlCzPVJlUmGC5BrUPaxihXygwD62bQ2ZO3n5VnON/nfnTRodxioMEdEi9bYO6tNdbOK1d1/w633otbhnryi/rm6BlOFrfuzw4Pnpy67G0FVdMUN1JK0HCtp2v/qM7VcWLjQ2nEsv57lExvG3vp6Sg8q5NsTnT6OxW+a50ah95VO62rhlicGuJ5Ud7j8WYrAtKh9VWejN7HGaph5teNHKM1EthPgT6exE9ckOR/yhuVcNOOWLVfCd/iW3/99//2SH0ztlwITw6P6dLYZSj9FWPab4hqBUdSmXPf9nTgrEus1B7UDfCH3dViNEC0NLu+ifLjn1fdy1dwsoBfemkOrq8nsgE6WZB3Z9ET6Zggh6LQs+0i0I/nCBBIqAEIKBboCwQC+aLufApfFGK1HmUjxCBkqUmgoAXzkzLwQ3hk1Lv4ejwoMWLxUS3JKgHpT+LgQn5S9Ni1HzOeBBANrIvCBuY7cws5iLEIeTt9/oNnS8Wix7Xj3thPNm176rdt4Oz178MX3fpnVXRfS3WgSK1F7rpLLMap3RiSFfFvYPennaQUCXgrsSP+dBssy97avtVOcz59rXa5/9azaYTOlm2C73JoHT6xeCbW2d+oCMVIRwbW1oxDp6drP/MDYhiCusgug8P1MVGIF+t6DZyWKwhGqwKgZ9M3AAhqei31979K9vHdnbSfIdt/sVcqwYyXBMQqNEoxJTE9zoRrpdy9T4vLbUM5r1KgVnQbakiszcIQETJk2PLuPTyhjDIyH7PN9M43Yn5gspe/D1x7hzdsA6jPJvq+xUkYMiubKeoivLuNcqzP0iwVkXVAZ+RxRz6euSV7ym4AGb8kA83Tx59IYdIZjQtGxX0/wOFxKYI
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."
sidebar_label: "Update OAuth2.0 Client"
hide_title: true
hide_table_of_contents: true
api: eJzlV9tuGzcQ/RVin2JAWimO+yIEQW0nDdxLEtgy+uAKMLU7WjGmyC3Jlawu9NYv6af1SzrDpfailYO47VsgQNjlZThz5szhbBmlYBMjcie0iibRbZ5yB5ZxxT6eF255yi6lAOXYQhtWWGAb4ZaMs7fccfYLNw/gcskTiKNBlHPDV+DA2GhyV0YKX9Bi4vdfpbhA0Ak5d0t8NvB7IQyk0cSZAgaRTZaw4tGkjNw2p33WGaGyaLebVYvBugudbmlFopVDm/TI81yKhJP3o8+WQihbpnKjczBOgPXbvCcfvFvlQdwhSppkesHcErrxo8cHfg2CvbdtO0+Yba35Suu7NkJ3bddn9Vo9/wyJw7XVaptrZatIT8fjvi+HKWMGJOY6PUh04RlA6fqXMGtO5kJgTT6Dt4OjSUF69Py9evvMTNxAYsD1DVXjzzR2nCb/Nz+eT4xBlBmu3BRHbd/ee5pjfpJxKfUG00uV+1WGnVhhkfFV3rc73U8d9ZIhvryKwTDJrWMrnYpFIExzlFDuCWZ7eehksZOHTtBtR2dk7pBgaF4UwXyHjDNfKUvgqdeoMrqsGD6cegtlX4Q81wcRPOJhkgZ6hYAGD0q+ZZNVZ0X+3LPxy2eJVxslMEabS50SFP65zaqeIhzWWLO7iQxzARm61grubDzeHTHfk+Q2Hhc8ZULlhWO1+ntB6sFyqygT2og/vLY0SaigOfuGobkGqwuDgqw03bOF6gP0XSXo3yhAV3ieUVwyC2YNhvljDjDCTRaSwgi39d3HBXADhlQKX2fURDieUWOCx2Ibg1W6EFlhPICWYMDzlzqlBqXwKFCbMolG61ejxK8d4bXIhzbHm3NUqcqwUqhRudewXUROkItVB3So9SsdIsB1hZE4tnQut5PRKMW5Ic9FLLzQxUKjsPTuMYwAMXzKhq2mD83MGmBuiB9VWs9z8RNsW/nh1UBo0oJuDfZN3Hmo3b2gdx07/3TFHmDLCBUEItAyZlO8KNZcFvWVed+xcx/kka0KvDLmwHIDC/GIV5ZvMu8rH9k9e4GFAd6AM1xIjwHl4WTAIM7iA7MTFja+3mJZERxDdO7NfUxa3aZFGc392w/arDgWVfTjr9N+bEkC1jKnH0AhT63du1dZCj4jj1nHCVYj6IuSMKwOa25Dypu/Dql8r5sO992+QLoda1NBR/qK1i0u1ELvtYInXitQFAQxxRZ5ro37vmFHnWDxvhnq0qrNyANs6k3sxd9//nXCBDYd7AZ7DmGXjMqFwWOy5CoD/J5IGZK2bgo8iUVCOddrgUjF7MrRB4bFGbkYWo2rQWSK4SRSym0HYT+fS6CGww9zaQd4Zioy4VAfNtjzYKdHh1ktRcpynTIHyVJpqTNUNCSMQgPEIM4UbJiENUiiJ2maFz4+R4a5rTeChNZIDVqeaEyK4CoJn0A+PANZISsJIQZwtiikpDpI0R3yc8WVwtgQVBRrwPac0rGvKaQwUvo0Hvcw32w2MffTsTbZKOy1o5+vLt99uHk3pD2+YXOykzxGlZjqpFghOPtaJTmq8nU6Pj2LX8UvaW+urUPvWv5Un36hs4vHTaOYdgW9voT+08diKAIHj26Eg8J3Uh6FMmjvXbR+VX2FoPqSG7X+4ktHgfF9UveRqHdLjI32l+Uctf7WyN2OhrHCDF0O+LjmxhOpkmlh6Rm1f4F8gi8E/OI63Ksn7KkQ9nKqSEu9+OEbPj6Q2jbd7m5Wd6Leh2q604822480nfsdJE+5++La9t326ZYUbh6+o1f+Wo8M31DXjP+T6Df8Ebx5dS9SK0HjZSSxjAue1U2xv3F50NEQdK1w4YECO4rH6yCeU1LVNzU6XmQJmt3uH67mxdw=
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.

## 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: eJzFVtFuKzUQ/ZXRvtBKyW5peYoQorSlKtzLrZpeeKiq1tmd7PrWsY3tTRqivPElfBpfwox3k26SplyEEE/Z2OPxmZkzZ7xICvS5kzZIo5NBclshnOY5eg/XRuoAZ0aPZVk7wQbwHoMoRBCAurBxf2wcCA3GlUJLH62+8JALK0ZSySDRg9TgsBSu8BAMCDhnB++Fe8JglcgxTXqJFU5MMKDzyeBu8Qqoq3MwYwj01b2KTkq2sCJU9K3JB/3rWlwVtO7w11o6LJJBcDX2Ep9XOBHJYJGEueUTPjipy2S5vGdjb4326Hn/+OiIfzbxXGJ4I0l+nSW6OTc6oA7sQ1irZB5Nsk+eHS06QKwzFh3nK9pG7w8xxQ+rXO/i7W0Be6Ny64J9vHmXLHuJqENlnPwt7j54dFN0f3/Bh1M6BqfdszCMZ9lvJMNOieiyEsMD2chxG/8DFwT9PwmNc/5zxwXcNC42AnsVQA9mFTok4nUhQAuBqKphhERSIqsIxBHCa43/14Cvycd/ithhjnLKgAlxi8WMPmEeGsbLOjL+bg+Z9lDgc4r1WQm6XzKuCkURm3qRnDWt0L+NUBe7TRibopfgs5hYxQs7HbPcTnLXJzR3UTpiQkTJUpK0XPVdribU5SQ2laH0cLhRf0hABkk2Pck4ETLHjDu47y0JVLbYVJRlls5Qqf6TNjOdNentx6j7ebfpyG+T1ddE7RwnBtZJr52itSoE6wdZVtBeX1iZytIJHVJpKPRtB0MKkYi3z4dvtrfd3DOmvHYyzIdcgEZvTq38EeedWohmoZXXNrNrgd0QgF0Vur6CJ5wD84uK01YwBZbxqVA1rpT8ccPPY1tAmNREciK4dTiWz1jATJLoPDYY4REOtAkYHQQnaMhwDrhMhz3AtEy33A6gPfj13NSO09EncN88psym71A4dGzPsY/iv++Nmwhq8OSHX273KWwwT6jBCu9X8BpPLWYeeZsiuc5gZD3nsLksWbcu1y22stRjw2h4dIg8Kg31ieTa+tpa48K3L/Vcl0RevixtEqHLoa1o1ofg4M/f/zgE6UlzhjMspK+gmfPPeSV0SVqki001atuEIjZTSbGlcBWgprFJO2rc94asUZYaaJNIEOa99rwYKYSctImXhfI9urOQpQxCwUwoRULPl3mjZAHWFBAwr7RRpqThSCXW5IBrLkDjDBROUTGhqPswztDm4TGPToiChorJ5rkhVZFCE+RYsBgevUtq1U5tqpmAca0UM7cgOIxzIrSm2CippERIrwIux6oLiHREwuP0aCfns9ksFXE7JenI2rM+e3d1dvHT8KLPZ1ikZFAbxQPuncLk9YSSs+ouFpCmXsdHx1+lJ+mXqxlF6Lp49j9Jtnm8eHmY/G9Pvpb3AZ9DRosyyntM46KV47tketJqKCWQY1hLMv0Z7DzzOqrM422/LpMIVpQ+vmGxGAmPH51aLnmZhpgjHbyjz6lwkauNdtM99E0DY0yUxTfSeXDTPjYP4c1366vhr9RXs/RGraR/9PnE4rz9rl3erwdsxNgYcSlt6BzfnaLd8Xd5cUuq8xfkfEdi
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: eJzFVs1y2zYQfpUdXmrPSKRr96TpdOrGrkdt0mRsZ3LweGKIXJGIKQAFQMkqR7c+SR4tT9JdgJIpyXaaXnrQiASB/fu+/RZtUqDLrTReapWMkusK4bTxlbbSCV6DK7RztPAGvSiEF4CqMFoqD1NtQSjQthSq2/ydg1wYMZG19BIdSAUWS2ELB16DgDM28EbYe/SmFjmmySAxwooZerQuGd20T4QzPgM9BU9PfVd0UvIOI3xFz4ps0Ft/x7igdYt/NtJikYy8bXCQuLzCmUhGbeKXhk84b6Uqk9Xqljc7o5VDx9+Pj474bzueC/Qvl4dc5lp5VJ4PC2NqmYeN2SfHFtpeBMZqg5YLxW/SuQbtfmSDnRDGYR+MC/Ihp5IeGQguz1uObB3eX/3wktUg8foe1cc1el/3c837H9F+f/n6XzoixCXZDMvf4O+yd+y/uJ2LWhIC+PFbE/1QoUVm8mmeo3MQE59aPSPGvmvqehhoy0xC54ngCiYI5JWrX9BB+nWUIJ6tuNTRn558wtxHEsomkPBmDfMeHs/V7fnEblfsq0JRhN5pk1eReMPr4L7d53qg4CDBBzEzNS/s8XO1W5y+TYi+KMWQpCi5Y5On2iGhZqKerjSlnJToQ5tTn46SbH6SOdojc8y4X4bOkA5k7XbjrrJ0gVT4e6UXKtNc3qHo4z500Q81dHh4SjvOcKZhs6+xNa1V3hs3yrKCvg2FkaksrVA+lZpS3zVwRSkSYZ6z4eLnXTO3HFPeWOmXVwxA7O5TI3/HZQ8LERc6Fesqu9GxLZLvMfb03RjucRloxyoQEUyB1ZLY0uBaMO+27Nx1AMKsIR4Th43FqXwgDi8kNdZdjBHu4EBpj8EA0ZG0nGvAMB0OANMy3TE7gu7gj0vdWC7HkIL76S5lNv2CwqLl/Zz7JLz9qu1MUGMmv3243s8tNmHgOhjh3Dq8aKmLmSfLthBsKhhYzzWMzpJNOzJuoT2lmmqOhoVa5EEhqE8kY+saY7T1Pz/iuYFEXjwubROhz6GdbDaH4ODL358PQTrSlKsFFtJVEMfpQ14JVWLQkSgqEU7o2oQy1nNJuaUw9tDQdKIv9XToNO1GWSqQYRT45aA7LyY1Qk56w8uidgPyWchSelHDQtQ1zTB25jTpChhdgMe8UrrWJY0igliRAcZcgMIF1DjHmglFmoNhYsX5vlwrnyYweXuuSVWkUBRyAKyIqlk2dcgn3AYETElQmbkFhcNxzoRSlBsVlZQIafgyHOsuINIRCY/To72aLxaLVITPKUlH1p112evxq/M/rs6HfIZFSvp6Czzg3il03syoOOvuYgGJeB0fHf+QnqTf81mjnafo+vF8ZfJvYd8+XgT+h1tVx3mPDz6jRRmkPZSw7aT4JpmfdPpJxePoN3JML6O9m1RPkentBU0mAayodOyhbSfC4Xtbr1a8TAPUkgbe3PJQs4GnUbfJDz3TsJgSXfGFQh5cdve5Q3jxavhk+mvlVcs4VRt+o8d7Fubdq+PqdjNcQ4xxE6uT8b3j+xO0P/ouzq9Jcf4BjKAHAw==
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: eJzlWN1u20YWfpUBr2xAf3YcLyoURZ3YCbRdJEGcYi9iAx6RR+LU5Aw7M7TiCrrrk/TR9kn2O0OKIil5nbQ3C/TGlqhzzpz5znf+uI4ScrFVhVdGR9PodUrxvROrlHxKVuCPUDpRDyopZSaUE6bwlAyVFt6EX0udkM0elV4KcSm9FBdLS5ST9mKlfMqCkHIFxWqhKKlkLpWLM+NKSy3xjxQbm4xudDSICmllTp6si6af15HGFziXQHen2mhWirMEeorvUEif4nP3Yj9r9WtJYnYpzELIPTcqG9Cy9GupLCXR1NuSBpGLU8plNF1H/rFgJ5y3uGy02QzW//MILcz8F4p9z6v6KjtQZ9926i0Lu8JoR45/P51M+N+BKAoVvJh1wvc+hG8WwtcNF7yIjfb8CfZkUWQqlmxv/Itjo+uWU4U1BVmvKhdAiZlu+To3JiOp90LAnsAkOfbseWb13NsMWqAFF7Ps/SLQoz63wdsrn1F9YC3f9+U6hbpZZY8iNwllrofUKlVxKnL5KCwtyJKOwWGTs8vOS/4GP6FCX8BRDQX36Dzl4sjSUiFWAbj64UAsSh3zA8jNLvHVIGlk80CQj49H4qIbqu05hqECOsFNhkkbzwjNSeQ4Sd6TDokGTpcV/7T0pQ0mttZGYuZZtSy22NbumpXmJDciQXomVMUFgjZkg0CMc+VxNtjACQ5BecA8gEjGxga+CQfBjNpXsWYlYmAFK2zB0QOxfswURtrLbYTdCFH6MsT9QIIh5/pcOoRxITOHlOhyTiX7yTGIFsbmEvyN8Jm+yLwINDg/e3l2Ik/pnP7x8vy7yWRycvYyTs7P90jxKdSzbhJ3LzJiGm6DPvsGH0pH9sf66yg2+d7ZHxueMcoAgctvmynjHosqiiJYmbon8PjDbNZ17lNw7GsdRGar/TS52vIbeLCdppBbEFZUJkfiDQd/S9ibytRNJPD0JuqR/SYaideAFfQFJAmnUYaSYAVAt4htABhU1Mjhxw/WAHqy3wL0oWDL+cnpgWADu9iUWcLOwKU3Pw3EvPQA3SLJVmJFIjEh3VL5AIkmDUCMrYeiqF10yLHLV69CyQjiuUFXqct6ze5N6BnPFyuAbqXrdIXPVd8YNGEqUqMpuu2nRdVd9rHqXv0dpKrC0q7BAXmZHwa7118sIWhcckBrjuE9PaKTynsuBcLx/dn2nUruhHT4z2bvAj2D/88ecMViQJRVqqs+q/IhiLF86dJ3xoOlVf/6ZFAjn9e/pAcVso8r6kFwkiDxVFodtgaho/fXxwcMAgtd5hxaYGaNCuOLcdEtTmKmPUX7/jkLpdFR2XilBW4ecj9MDj1dbrDMdpBftXufAYWf78fws8vlDRM8OpucsNtfPUu0SU7WGvsanY7R4c+XLYdv++f1yb/T3sGm4MWSbLtEnE0mmwPmD0C9qyqvJJeqAtWhmUzDdTf7Y6YsfWqs+o04oCnJJAyx6wqas78xNB/JmdIiKbikhrawB9DLapj9mwI009thkixmJBGO6WEEJUdxadF7wuh7UaifiD/ecn57ueSFKXpyyXKMBFxIDTCLlhSA4MVkGo0fXoz5YJStMQ9fw6TRHzYz2riaDMfrZ1axzXhXUMbr9rKzifgGfL9qteuXs9zU14dcadEqotT7wk3H4wS/DWWhRmpppfYjZaL9HewaEHCPfsKGq37um7ndoXrN5Ko4scW2Ca6sHtQLXRWW3Up3USd+IOteob74MOMuKbg88OxQcXokeOZ8kFnZNOS7jp07UR0j8tJ5HlQKLCTqCyanMPTfVT6KO3GErKq6LoYHlQUMChnT8UDQCDNa1+xU1IrfPyInGY4hnPvhLoxfr0hasizPd5+Hb2+2w9Y///1p/25xTM7VrbOQzm3dqyzVPvOc0HFCNAiGjA6rY1CImmzluIVOo/TCbEuDjENpqEeJyJVFYaz/cRfP3Zb9dveoS4Q2h3q3aZTE0X9+/+OYR2wprleEfEgF8x5bX5xKvaQw7YBmzagh6gRqxsKweWFIcvglWwydgTSppW4GyEGtL+dYmmKUMn6MhWeAMxO1VJ4bMlZV8tVoZTK098IkwlOcapOZJQoYQqxhgGOO/YxWIsOOlYU5lUsK1zk5Bycwr7IRUNAgmCyOTQT1NcztIWDhethhyyzcx4U1F/trljFzE7jDfuZSY2/kdQ21mbSj3eiJpJEIpjgdTfYwX61WIxl+Hhm7HNe6bvyv2eurd9dXQ9bZ7AbiXRw4dxITl1xhttnFBaSK1+nk9Gz0YnQSZj/jPLxr+fMWyB1+BdKncavv/L+8BquzwGOpGxeZRNnZ1KCu67L9OXp4UVdUwMlXeqp0h32ifsk1/Zo3aa1Jddp5XYVqmQJnPny95h39Z5ttNvyYl7jQjBAfaQOpqyKvHH9OmmX+SeCPPtYt/Vh87Ru7gyBtK7bmch3qa7Uo3nNBf/ZFYugrf93n1ivAP+FkB/MNrwV1vWREKxEuvIVvKe+NS5t2v397xbVb1oV919TuQ1OrP7ReqHUd6/e3ygX+21pruyrfc+aizfzQiFe/PKnQdIQtBHzxzea/ccviUA==
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><TabItem label={"HTTP: Bearer Auth"} value={"BearerAuth"}>

Access token passed with Bearer prefix in Authorization header

<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 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+luGzkSfhVCf2IDkiz5SDLGYLCOncxojiSInB1gEyOhuimJ41azh2Rb1hj6t0+yj7ZPslVF9t2y5GR3Fov1H7sPslis8yt26a4TChNomVip4s5p52dprGE8itgFt5xdSBNEyqRasLOZFmIhYsveiUDp0LCp0szOBVN6xmNpOJLoslAkIg5lPGMqZvReqwgGTRtjcwKaCHbZx04Ii34yKtWB+NiBwSx7lhqg+MkIfSPxVf9j3Ol2Eq75QlihTef0w11tJ6/TxURoXFd7fq1i5lomtGzCZzImLvrsjMViBtc3yB5LYy14yCfA8w2PUsGmIA3DJjy4RgqfB5/7sLTEJX5PhV7BTQxcwK2aTo2wcK/F76nUIuycwlwjuh0TzMWCd07vOnaV4FAZWzETGsaGYsrTyHZOB93OQsZykS7ger3u3mVkI7mQtr5kda+/8FucyOK2PWthUx2zRNCuRf9LGRxWuCor8h0o+H4GX8kI1MQmK/ambAA4MbeCusG922wV7UZR2ZjVadu+jNUwp1PeiZGzeGy5Tc2ue1jOBTDsuDY0MzPv9j0waYBlXCdjP4393Z7oz/qMB5n1gVHS9f5OWsp3c4WjTaJiIwy+PxwM8F91A9s8mqHzw7qBAuXHFgnwJIlkQMo6+M0glbsSF4lWYFVWujVRJQX1nLiPFiWuudYcxSutWJSfq8lvIrANuZ95Y4Z/CWwSSEKAikvcT4RdChEz7sQ/JkOBIaG7f49WwsbOSjAiccsCIDAB5YESRIgqnSg774KTG7gFw0RdpgnsCG6/h7AB1hSAF4k+u4Q3bxLbG8U+PIQYgMBzhanYhc4175WL/KCI8rXnHHSLDpobToXTlqWAmIqjFd7JkPwmc3NUGYfoAdNxJ7QxjgwbFykLU/rQkSHqmMcqBs1GI7zboLpLsUgikME7cSMNKsONdAIeZ0v4p8S85738TiV2hDOtXAhwlkWCz0pBgBhoiybmQkQg27ADxl21NNhBwwfqVvM+luDGW7MYkyHcyKkUut9ZV+WydQ1UUKCVMb0y/zwqEa3lOFpjV2k3HBjXm6aQm7UfwpzLbIo+xWYz2mCiMpjXDDSzeswMdVe00kb4oGQCt71Y2Z6Me7gPnJvHp4aVuVDxGuNs19N06qZLZBcHCS3/AIv+Q4TjmCdmrqx/6h7+wM28Yj872gNIfsEhimFeELcwkTby9OT42fDw8FA8D54FR5PJUXAYPH06GDaUm+2YjS5QaaWt7LwWCijXQWOBt6hFlRpw6I+ePCSESWqdzYhgToYIiuIQeQ0EDJVGIYYOeBqBxj6WmKLsJ2IEDx8a6yYKgvjK+2ktMHeu1iXVfJUYnx9/c9jqI29/yuGfs1eKwUsOe3JaBvvrrCtmsTMjd/1+f926anktWV/KRf5fpQWh2jfN7U8URCEeb1rWG3x10RHAXsiVkAhozUyotNFITCFRRTy+hhTPWkwek0eMmg1ScFQM5FUP6Bf0FnzFTDox4G2gRjAfMImpJJOQMUWYNpf6Solm7iB8FtvDmAEb+3H85vU+XnAGu7eApgEyrOgxO8+CKTBDeG+M9ipwNKLR0cvLV+zdq3P2/Nnzkz5jI5vlMVeBoMFADI3CHF45e2fiNhCJBRkEwhilRwASq8Iq32cCwES4bsSVnaXCh5PD4Cg8FifTp/ddNwSHyyD/bTrfG/9w1hvuI19FeNuZpcPB4XFvMOwNTy6Hg9Ojwelg8LemJ2R0kQeysSx5oI3NAeAJ0GkfhV8EmNH4DXsOQZG9vzxHdQuG7CGbPAWP0biJFyu09xsZplmybHqDe4sRtFuHrFVSbxA3PSj+HJ8cD/mheCqenTz9ZjAYDI9P+ARQb9Nup0KLGJAfIC1AXjwErMZSQzANvHQOxhhAiEWkZ+cQJzLxkLGkQWZiyNptb3rdW6hQRNWMeD9KGE2rhDEYxYpFKp55rIiZ2dh8QBeupvhKMQlYN2cCOQIEHAp3+zD73c16g6OmAQEFoXsAJaE6QCzBIe9OAdSyqVYLlvgslhfxgUokyJJe1pytyn8BEnfeRJlViFJfySvbWwJ8V/ETy65jtWTSBZn6KMpTrlCAvAzYB/x1vW6Hwq2QLQfjQFqBS7iKIwdsjsZ94KsMpx+AvhK+ihQnHFYikF9fwPaAF3h0A2qa+jLvFyhhVP3h25xSy1OPz8pvxiSuF6vWx2em9vjHpflB8JBOG8pVQkuOzr05B5GXKLPspnj9NTVDoa8Cx5PteinsVBdsLTz2KGc6CrhE6HKm28h+hlE2Okh1xR9/vSzYrszNtLy1zPYDCzLdclUZRFwuDMZN79q2YtiwPq7aYkhbWT9jSxFFPfTA2IsDamowcrxw5cqCSGHcxPX77K9U/1JNbE7Zk2uxmkg6cvz029I+qTPy9iFqK2jhnphXeQmwukAAoRnMK0wxrZQFsWHtTaG6njGt0FA+AnyaQVLWlJMCvUqsmmmegCgwW80zMOTOBICT/CCjy2Rf9EsvYWSbJNYbvHUrhy9EwEEFmEcL13hiAHa6eI3ZDdFpMOeQ3Ji6wSwGHt1FnjQdYHAWCydAY5UWHp6X5nNLG8BpBJuAOWAFAIo7lQkg5OFzXpNMyWwp2xJwzCCNN2Rm1ELUi/NIqWtUd5pgeCe5rPCeUkE6gcoJjSJHoI4dMAxtV/12SZ6Z7ZJ8KemkyJsThYKWc87y8+ZhZ7nc89N8jVcdTCVee8Dd7p0R2SSdYPmjqqaTdyvPCPDiaVddMl49MzoNA/cal2qyrFrbg3rg2cnwZDsmvgfmNiLhxizSVvDtUNQVoLJZ25GVFPsCIRDoq0WQLlQ4S74yjJI3GeLWjFEc6hXFMqW/rdLBE4JaDUUwtn1PiZJ4xmpV1+0HvIm8zhtimLP4iWcsfnJYqWmW9wwunTy0KWRjkKyFgW3L+HggDc0bXWRy8OiuppcC2rWfZ34JwKse6z7ivEec94jzHnHeI857xHmPOO8R5z3ivP8eznPfprcbx6//1g/7DzV5HyWrp/ilc+MiPeP+eAjZndaofWXfaaFCbpVOLX+ATTufCDy6ptaiPWo2qIy8FiLBoK2S1X6DC/q0vxMfG3vGMkvN1e9aaLqsFB33+w+NmkWzwQ6RYlqzg9BN7aNNEXzMWsvawFiG9d8Wo+oQNkg1OImFEWVhlTuyyuycu9HU2+UbwMpn5kM0NmV5NKp122yid4mDS51k1KXD+A2XETbFlWkfnmTEkdcvIY5MFw0ILGt1y1c4ggXcw+20X9dYzhreKtIYAEEAV9m39wclBvd9QIsnmK3zrwT1JSjQu1Vei1v75SvEMLtBHdvanJnVDatcFm5pxarY6BVRmxNOIHmcu/avXpZyGl1n1AhW+TZa7xJbN4y0RJO5tVwEPh4MyeR3bTkr71JorfQ55DdkBq8vSmteNSVU9bJidptp5Zs7HqDJNMi3BLFCHi84folPUlSf71Cl2NAQy/u4+AjaKSsBh564Hr7/U9FkRRJiLCwvaJmajOhzPkRLaVfUAHyWyJ8EXl5hQ6TlM+wL3tz2aFASC1++dmbUuptwCxVc5+Dm6MDnhwN0pl4BPHp55jnQuT85JtvakC/EQvk9wLhU46fjubWJOT04COFdjyeyL6G6iW1fqg72pVYJjC366mwTDeNe18lcFaJxTRek2ExARSume+D7XufZ6YzvjD3zxpmlqVrJ8HZEFROaMFZagW+nviyXpZgpP1fofPb+zxapwd5NjKRTeQsJYAnYHQYTS+wz24uVdWW31ZB8SAYJh+zeZdQ0WyV7yvzEb1eQ61EcPWDuu8+EQV4IgGQax+PeJ3T3KvvCjGcajb3RJ3eAONcAtRJuTMaeo+R5RjBSYYLlEiS3pKBPE4pDP9Qbth93sBbO/BuQJPndAvaJfpMmidL2L4U+c5XI74tHVUMo21BtN/kktvfPv/9j35Xn46UAo5476CpufSlfr+eY94LsZFNTp0hqBDZURdOewdpfAAD15bZdZUUiddAH+LkfHkNO7FKH0EwiAFhiA5ulxYzCM55Eha7jTUVqBlEIVBwDAdQ5JsIl1F43UMZgbse4gMGKT8Am7IqIgAmqheuaChREGsmpZkOF0fa0mFFXFbbRSWwUxi5KtNwQ2EE+FzyOsQMU0UYgYkORL/MCMDowwsP+oCHz5XLZ5/S6DyD1wM81Bz+Pzl++Hr/s4Zx1gfkKPaDvhCpIMYxk3uUryI5r7Okf9Yd0GKmMBe5K/GCX9m6/0KibdSmZ/G/90MP7jgVEdJBEXBLCIFXc+Yj9oXNz5OOwzIF+a9QmqOTEA0FyDuLF2Xd3CELf62i9xsfuFwAUzWEPYCFhe89fWaL/2R+ctIrgGoN58bsTmg4PXBbZmfGH/nrkHlYyAP+FnOy98xhmn/1Zvxi5T67NpvQv3Nef/tORe3ZV+blLsZ8rvNEUtQlAZUiLnMDNxKSYlLXbxP1lQPX9S8yr3CfdAnBcE+DwF0g9exWvSrTr2MOxgH9R9K1TvsWoChDgu3y4e7NxQp6t3WiUElZD/wJeXmkh
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: eJzlWM1u4zgSfhVCpwSwZSedzmKDwWDSnfTAO4PuRqcHe+gECCOVLU4kUUNScXsN3fZJ9tH2SfYrUpZly0Eypz3MJZFoVrH41Vd/Wkcp2cSoyildRhfRr8o6K1SZqieV1jK3wmXSiUw+kdCVo3SsSuE0VknUZUomX6lyIa6kk+JyYYgKKp1YKpfxPmyyFSVqrigNe66UTXJta0O97V8o0SaNb8toFFXSyIIcGRtdfFtHJV5gVgrZrWgnGQRnKeQUW19Jl+F590q/leqPmsTsSui5kAMzgg5IGfqjVobS6MKZmkaRTTIqZHSxjtyqYiOsM7hr1DR3vNlWurRk+ffT6ZT/DZHkEz951GalmG1BxWmJLh1uwHKyqnKVSJab/G5ZeN07vDK6IuNUOKrnmZ5l0hi5YhAcFX5d5vmnuQew3aEffqfEYYtTLueFrTUDwG4yiOtlvhKFTgkUkH3jxTJTSSYKuRKG5mSoTOBlXRBYY53kN7geIvQdXiwhYFcWdokjQwtgYvxF28WRmNdlwgvYN7vCqwarZLcgyCXHsbjcMaA7B+iCZzaYKfBQasfkfCBR4CT5SKWnIrxeBxKU0tXGq9hoi8XMsWhdbWjdmquXJRleS0HgFJdqDzOeLwI+KRRCpYD3OAKwUR5QDyDSiTYsLYXFxpz6VzF6KRJgBS2swdITsXzC1EJgyA3RbQwvfR/jfoi/MUfDg7Rw4xw8AFX3OJIOSTuK5toUEnyL8EzfZVF5GpyfvT07kad0Tn97e/736XR6cvY2Sc/PB6T46gO+H0nl3kXiqGHNwemzP2FDbcn81L7GiS4GZ3/peMYoA4QMnukzZbLHokBROCtXjwQef57Ndo376g17rYGIRDUMk+sNv4EH6+lSnQFhRVAZiw/s/A1hb4Oq20hg9TbaI/ttFIv3gBX0BSQph1EucYYA6Aa+9QCDiiViePXZaEBP5s8AfcjZ8uHk9ICzgV2i6zxlY2DSh19G4qF2AN0gyJZiSSLVPtx8ZZBdGIAYGwtF1ZpoEWNX7975lOG3Fxp5t023Lbubphm9JlkBdCPtTrb+ForEqHNTlemSorv9sAilZIjV7tU/YldILNQLY4+8LA6DvavgvSE4jVMOaM0+fKQVao185FQgLN+fdd+r9F5Ii/+s9t7T09v/4gHXvA2Iski46osin/023l/b7KN2YGmoN181cuTL8lf0pHz0cUY9CE7qdzwXVoe1YdPRp5vjAwqBRVkX7FpgZrTyBV7b6A4nMdOeo/3+OXNVkvXKgxS4ech8X9H3ZLlLYLaD/Kpf+zQobAet0G7/49k8IHOfsf0yftf47WfTE77Sq/uCvjoyRpv3qIKMHD9f9S5zNzRlNzC20ltIFaxYkOmnj7PptDmg/oAbthnnneQ0ViFzdH0dg9M0wyZN1i7TRv2L2NkZydS3gOsAzdlfGJovZHVtEDCcbn3JGAD0NjSgf1GAZuWm0SSD/kn4Y/YwgpClpDaoS74tvqzUL8SPdxz7Ti543IieHVEsIwETMg3MogV5IHjYuIgmT28mfDBS2oQbs3HayY+7/m0SusbJ+oVBppmonSkh3CiMQvvJrdDthbGvNigcUeZcZS8mkxS/jWWlYrUwsnSx0hFX170uH5fmiv2MDht+3ldzt8XxhukUWLBBczuQhIV2LAuOwFs7zV22oe7pOUjbl59nXDMFJwTuJAKLY8Ed6JPM66483+/ouRfhGFHUGLzQtlQYT9R39FF+BLgPNop7cYQ4CjUYrYTKPQaVTOh4JChGx7ar9kK0gj+sEIUMxxjG/Xjvm7F3JA0Z3s93f/BvHzat1z/++XV4tyQha9tCWklrN+YFTa3N3DXsGCE6BH0MM4bhsKiLT/ZbxDRX5VxvkoFMfDJoG4vI1lWljftp68/OJern7dIuEfoc2rtNJySO/vvv/xxzwy3FzZIQAZlgpmMGTDJZLsj3PqBZ13iINmS6JtHPYWiZLH7J52OrsZvUouzayVErLx8wQiVIXryMKBnhzFQtlOPyjMGVXGi0dI5iX+lUOEqyUud6gZQFF5dQwD7HtEZLkWPiyn3XykmEM5t8ACfQvbISUFDDmbwdcwkyqu/ivcP89TDR1rm/j/VDL6bZPGfmpjCH7SxkiSmShzdkYyotbRtRBI2EM8VpPB1gvlwuY+l/jrVZTFpZO/l19v764831mGWabXu89QPHTqqTmnPKJro4gQR/nU5Pz+I38YnvBLV1sK5nj/9g8czXinQ3aXeF5v//vailv8NsN6lyiXzTtGiu2wz9LXp606ZS4MiXeS5L+yat/Rp08ZpPTr0mDuUGiPJp6zXP5r+ZvGl4mYc3X2jgCWk8fUM6V5af026Ifxbjoy9tuT4Wr/2WdRCVTW4uOTH7TBoGxEdO3S9+Ymu4+W7zENsfpDihVa6nb9B4NP3K+fM150TZJsxtsXj0xaJ96H222rV1v24EE/hvb3jcFfmBIwLp+8due/jlWYEu04bdjBw36P8Dt+1gyQ==
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: eJzlVs1uGzcQfpXBnhJAWim2ezGCoP5robZog8hGD44BU7ujFWOKZEmuZFXQrU/SR+uTdIZc7UpyHKdATy0MC1ySM5z5+M03XGcl+sJJG6TR2Wl2PUN4XysFlyIIQF1aI3UAoZRZehBp+sZLXcEY3UIWCMHsWIiiMK7kZZoWAN5iIaeySKuX0hfK+NohnFUOcY7k2yGbgJeVxhImKwgznHtUC6QDdbk9FMamdgX2ACVtcLRk9Gpuaq9WYBxM6V90x0ldyoUsa6HyjzrrZQ5/q9GHc1OustN1Vhgd6GweCmuVLATnP/jkGYR15gsKQfAorCwSLGbyCYtAfqwzFl2Q6Hm1pMC6nNqUPsSMRuWOAx8cgUIO9uF+HpXkA0aX2aaXddl8jdNRuzuab1L20iHZ3r4Y891mk0y8NdqnPI+Gw5ju3jHjuijQ+2mt4CyO4No8oKb7VCg8Ulj/Esoieo/OX06+CSXEUIiDE4TaE68EQ+ojhSJz0WWbTUr1ZPjmH3FiF010zrgLU3K6cXy5E81d74XMOusuLyo3rCg68vco5lbR3MlwuPmM+89g0Zpk56KkIrB1ACucmGPYJnwI2I0WdZgZJ3+njHrZDEWJjqPjrd+ki/+fQjOi85ymMvKRMBCPOcCIjDwWtZOBhOV2nZ1Z+SPy8G7DOYrKMxbjJG5ttXkGgE6eGYIqs8ZHAESY0ddgcTzwSVsHXKx9bwUNLWlsn78zPpHj8fHAA0HBuWnCpX21UzQ3C8H608GgpLW+sDKXlRM65NKQtjypagqZ5fsZHz4tH7q561AYMxnSHW6xaC9DpAkWNPYZYaQvTZfApdvwMJLraWG/H8EDroDZSgg2HMyBO9ZCqBrBTLl1wP2en3tIx8C89oHVwDqcyke6jCX1EdocQ4J7eKVNwOggOCFVxICBf00dJ6/yA7en0Bi+XZGmMBx9Cu7dfc5yfY7CoeP9nPskfn1n3FxQBWU//Hr9ZdGywvtteMlTEzORFvaCgBbBWIGMYTosa6uL7y22AK7VD10TvNpWw1c0sa6G9vvQdj42qKnZCoUoolCQIkhmjq+tNS5827GlvXD5fTe1T7Ndhh5g1RrBq7/++PM1SH6WjJdYSj+DMr5aHouZ0BXG1wORmB8ECa+mrAhPQ2mgy2EUuD14WlHTvje0G6lUgRaJYmHVa+zFRCEUJGw8LZTv0ZmlrGQgcVjS4whDPMwbJUuwpoSAxUwbZSqSMyKQJgfMKAEal6BwgYrpyoIWVU9MiHFhld47dTBEFd5eGLokKTSFHOkQ03NY1Srm45kRAqgDK66LksLhOOdCa8qNQCWlRurhfB3bGiNKE8WP8uETzJfLZS7icm5cNWhs/eCn0cXVz+OrPtvQbRAsau/ygCuzNEXNrNnWLstTuq+j4dFJfpy/YVsWOopuJ57u5XjVvDUPi2On+/xnX6dNsQZ8DAOrBKnjprmdddMVbrPFcSP8lBVj1HYG7hxtbyAhnnE3IYP1ekLPsBunNhueptJ3sS/R5QgXGR271LadxWbywHKdXSTA+9ccFm8ndY3qfdD6uXskCxYwG764d7fhvf9lzCI4aV7j89jmMyeW/FKn39PsI/3Rh4kkiM0kzq8zRZVdi4r3J78sbqKR2q7NPMQ20ww4s+2SXu1EedhxUjL8y6l91uQts52E/127Pa08a9BqdNrNd8tP7L8ByRW1xA==
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: eJztV91u2zYUfhVCN2sBW07T7sYoiqVJt2Vbl6BJ14s1QGjpWGYjkxpJxfEM3+1J9mh7kn2HomzJTte0l9tQIJVJnh9+5zs/XCU5ucyqyiujk3FyOSNxaW5Ii1/IqqnKJG8IqXNxVPuZsco1K6TzyijtxdRYbAtjC6nbTaWFsFRImzvhjZDiRHopXkt7Q74qZUapONLiKMvIuWhOOVdTLqTDaUuuLr0wU3yf12U5DOKWfqvJeZHB2oTEbfAPIjOyNAgeYkP2nMwpU44/osxc5iSELKTSUORx16gUamDU1DYj8SinqdJYmSzFWUX66PxUzAlq82Ckkn72OBUM1FZGOZHNKLvhG3S0t+KugiMbMHEv3qx1TrZcKl2IBp+jwhLNCZgulJ8BQz4Vdk6Uy0rjakudQ28oMzb/CgDSHKB6+JMZrSnj2wB1lu5CnL7XySCJF35p8mUyXiWQ8FDGn7Kqyuji6INjNqwSh1vNJX/5ZUXgh5l8gAHoqaypyHpFLsgGO8FM57DzFrfD4X2O/fDush9/ONwNaghnjCXlyXqQzLyvXocwPMzC95eX56IRiMofHCE2x2F+mCE++SUW6C4r65w4wMeldG67uTU7MabcM/puhluRZZtRRzCUM1OyniYxtWYeec4pFVRNJX+Np7J0tHXjVOfqVuU1Vr/Qvtpq+Ay7J2BxTjkQUPMvtZw3OvjyUPJp4+smDZQFs8a/9sjb41lkwdV63Yi4ymjXEP7w4ID/67sXCe0DoW+79XPjyYPzzWg6m8K7/czrut7mC99xn0eDpBOTAEMX66v14MHKLUn28GodsXh28OSzqkdXLVlr7DEcgd7wfdIB8WrwiUqzld5yBW2ICrKs706iFmLt2cHB+h719yT0RiR5KXOQuKo9UtpKlHyoXDf37cf5rY6l6fcAzozQVix7x0e/bpjxH4XmFPaslqVwZMEfEczsYbT9lRw3OA0vg+17Os493uwBuudGV6torCXBW0dZbZVfhsw6qtSPxJ/gNcCVheMg9Oeci3APBn8em09SGefb2jBORrdPR3xZldGIc3DoKgw4o1tZKvykYVNdEjbNmlyw3Pf2hOYmAoZztS2xxmXIjUejHHtDWalUFVZqnyqTcN72FVzAd54jPqLDNdu7aq62cFww6g2LWlA2AZDNAhcT1tmAOUg0aMA1L2ZCW3F2KiIa3w0tQytHPGLQmukJCNXUDkPXPT3XMWZiXqOLorFWFjPZHUo8T0Y4HFwS1+KRNr7pAd5KVQYMGP7HA0Fpke6oHYso+HyJsY3hGMK5F9cpE+glSUuWz/PdJ+HXt8bOJXI4wbiyf7duta9QeFv3Gk3RZ56Fe06IDYKB6qHXBYFkk98ct4TZyuR+sx3YXrUZsDNwbXOkOyRtVyNT4+81R3Jq2iIls1CkkHSKOePqqjLWf7PlySbU6rvtUp9gXW7uoLQREo/++uPPxzwpS3GxoFy5WTOyoJPPpC4ozHy9rhnTCkgaNDGyqTj1okYHxk45HTqD06QKPB5yJpdfDqK8nJQYxlBUeRm9D88DkatCeRSmhSxL8sGYM8hRUfGASNlMm9IUKKWgjoYC5pIUmhaipFsqmahcTEPFlRNwzS/bKdWAJHw8MwiPkhouByLkzbOlqMtwH8dckGKKFw1nRA532M+5xNBuU4CKokYYMDgcbXaBzCD3YXqwh/lisUhl2E7x9hpFWTf66fT41c8Xr4Ysg2gAlrIXPME5mZus5kdEm7VcmJp4HR4cPkufpk/CDIxCB+86/jzkabibKJ1e+P/z8t/+vIwVzNOdH0FKhd4ciLuKZQhz5dPYDUHZOLg2TZOJuNM20aNm3G4htlpNpKO3tlyveRnA2tC7WciGlA+dvJ0uQp+94U7WnzGCjfojY0QrwRer/D+e7U4E52cX3B8m8VE9DzNYYuWCR2f8HSfv8Q8/TMiJ0GfD+iopUfpqWfD5Ri/XfVn3Hp9oVDehA8ePzqtA6mXHy91m3FyG/3Zm/b7IcyYQeuKLzfFm56MCm/bVnOYI86Pgb0/Ha4Y=
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: eJztVsFuGzcQ/RWClyaAtLLdJCh8ihO7hYPGDmynObg+UMuRlgmX3JJcKYKhW7+kn9Yv6RvuSlrHTuICPVYG5BV3ZjjzZubN3Mqk5lEeXsujNlXkkilVMt7Jm5HUFMtgmvzzcPieolBOKF0bZ2IKUFiQaCMFMV2JhbJG48jNBRREE/zCaNL5vVM1QVWLRsW49EEX4n3jnYhtWVKMs9YKdceNkVCQNUH4mXhzeX4mPtBUXPlP5KJ48ubD1VMxFirrZrOBZoFixYeBhImxJQ0T1sOZpUmVmKpoys5VTUkZGwtxVVEkkTqjrBfoj9YEuDzzobfO0SCSRGXCOTndeONSzEaNy4HGVUxUF3IkWZ9ieuX1Sh7eytK7hIj4UTWN7SObfIwM662MZUW14qe0aghA++lHXAM7uLChkAxFfrvBbyAJ7OGY/DJTCEjApAGYWgfGBuixi2yikGtY7uF/yBaCrhW83Qk9ZJ9N/RB3eZTrdRc4A8fltHV3cNvNet2JRSQ9dmEd7O3xv7s3XFBqA2fjfmo3edrlNGcTWM2MJYHKU5yD/wj0/tbvY45avOsiw9y5/zjlPtStLkf1ff/MMIWoSJpDayTps6obi7Mfe0tfK5ytoPzoK6c9vdTUJkZnHIgRXFBAx1QUWjcvNLFnubQeMuZaa9WUraXQUn/zVRZ64GbX1pl2jt+enuH3+8uTCyadnUfdG4axq+JHXTk1IVXHoKhvlrZmgQe0Z6o2dnX2FbDuic/Be+7R0iaeA839nwbCU+8tKTdMxEzZuJM+2P830i+eP066qbyjs7ae3imxr3nef0by2UOteupKHwJqU5TofGZuXLJl/cw2z/b27+u9VZbTATYFyRoYYRdTR74gz45QakqV18xFPubiVwm9KCc8JCZ5/kysn+Mb71BrXKyoKXBlQIHKKqUmHk4mOizG09bpcR4IYczcELy1eFSNKcw8KJcK4+X6hs2UbTBpdckM0TXZlDAVAs+/AVpsnG/NYgx3FsJJ9/DzptTQ2zkUZp6L3WA42eRkSOy7FOwIenPGSXYznz0wKTfI8cVv4hXiEq+3AYmjd6fi2JdtjUx0g3wkcw9n0A/2Dp4Xz4r9niBVmQmyb2gZ26bxIb3cAYJa6Bwzv+yO7oI7QO9LWtsqiSd///nXU8xjTPPLJWkDkmSiFvS5rJSbdzsB3DSznqgFZ9OU2/UhFOI0MdNHvLGzcfSQJjN3wuSaS6tRr8+FOyxF3iC0mZukrFgqYJTyZdFjSxGN1wIzvXKey4ggTA4GeNor4WgpLC3I8vhkbs3Mq6bG4rpsBGXo627VyfVrlIPLeSjl8ALNW5vjiTAAk1hwLFRbDXfYz1o5xyN5JDGhMNZyPfSQHzUKtSUOir17mC+Xy0Ll14UP80mvGye/nr4+Obs8GbMO1xx3Da4YGuWeEblnvpxCg0Xl/13v0btezwaJPqdJY5XpZnfI87Fjq2vJYUoeY3VGfYM+T7uKeQ0it7fwlt4Hu17zMWgiYHe8xuNCBdOR8fUNTFekNLM2SO4TQUS+7pI2znOWxW3LDt1betajjcYRomzSN2VvBtT77vzyimmt32Zrr1knqCVvuvg+lL/jDz98LqRubeLzW2nR262a5/Ui2+XPP0INWwY=
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-15\",\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: eJzVVcFuGzcQ/RWCpxZY7dpGUqA6VVHcQEbrBLKSFnB9GO2OdhlzSZbkSlYE3fol/bR+SWe461iygrYoeqkN2FxyZjgz783jTkaogxzfykkXGzRRlRCVNfIukxWG0iuXPsdyorXdBFFqRVZBRCvsMoIyAoTBjYCyxMDb92hEF5Sp6cB5XCvbBb0VKoQOK+Fx5TE0vV0uFo0KosWyAaNCK0LnnPUUPVAsulaUljIyXUpJbFRsbBcpxq+d8nwDZUx3oedsPI7gqQTMZSbZEEN8ZautHO8kB6NjXoJzeqi0+Bi4vp0MZYMt8CpuHVLFdvkRy0hxnLcOfVQY+HQo4cAwRM5GnnRMrEGr5zWTGT5A6zR74vaqWb4p1Vt1NXv/aXZ+rWZhZuYvy+nsm9m9+/nD9OrbPM/lft9XozxWDNZjDnf7fX8UnDWhz+/i7Iz/Hecyx9h5E74AFif0H3WmD/v3jbmmFK5+Whyl8S/b0tf/4kslL4gcR60nDgplekysFw0EgQ+OW0qROMj5aZAfibfMNLJvQa+sb09InMBpkbhJ0EhnQ2oMRGKILJiSRbIrBq+CTomya/Q8djvZeU2GTYwujIui8uvRsjPVKM2LHzEy3mpNS3AqV7UHE3Nl5f6Ow5SdV3F7w/j0ECwRPHqe5QMYODjfmszouzeinX7xPVUFBL4kTFIxjPv8aXYuH3E54P4/hyiTyqxsykbFhO7r+QfximoU08/Ficm7mXhty64lGvYClEluUY/CxdnFy/xFfj5QFcpEVeKk4t4NqvHdU3MyaSBVqt48bR03+qCTz+n52Ul89cdvv3/NtAFxs8FKEeYVRCDasGLVKICqoDTVahgZwciqEkn57FpV6HMxiyxRLGl6NQqWrFHVxMWKlSpus8EflhpFSVzkbdAhozsrVasIWmyAehTTZcEye52tRCTVNFbbmoYvE2goQC+6POAa16iFXRHfI6YZhaXSdF0KQqS0hDibl5agVWAoZZbXvjyPdadTPTwwFHLVaZJw6CpKh/NswRiqjZpKWoEkPAzH0PKJA+KZuMjPTnq+2WxySMe59XUx+Ibih9n08vrmcsQ+zD+eIbriIOh8mLhninGE24HA/x8fq2FWIz7EwmnKlYmZ+rcb1ORWsg+bDuU/TmMm+bluWHnIaLdbQsD3Xu/3vE1j7On5u6XlGnziGX9R8AaBGJpE6B7JRE77/o0WnAqb645TOnkS9tmjx4Qa6eJf2t4diOO7tzcLlp3hQW5txT4eNlwM/R3LX+iXPmzCtH9ueX8nNc1bBzXb93H550/RAQ9X
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: eJzlVs1uIzcMfhVCpwTwTxJsegiKRfPjdl0U28Um2x7SHGQNPaNdjTTVjx3DmFufpI/WJ1lSM4ntxEFyLwI4I4qkSOr7SK1FgUF53UTtrDgT12lW6xgADarondUKJsm7BqWFDyhNrGBqQ/LSKoRL6Qs4wMmH6eUhFDJKmDsPymOBNmppQIeQWHMEE6kq8Ph3whChlivQVplUINTJRN0Y7OzJzmsMI7ipEMIqRKxhIY2mTQwgbQGNdwpDoFUklV4/7/BhvVg57zE0zhbalrBAr+dazuiQTWxhJAaC8vKSM58WlHtqjJMFZ0NbUZZBnN2KL1kI55ECiFkXrihScTcQAVXyOq5IbS1mKD368xQrWt61tN1ne+EK0lgL5Wyko/lTNo3RKjsbfw1c97UIqsJa8ldcNUjRuNlXugKKpOHy+0hp8i5WWuUANprSe7kiRU3VCm/z8LrWplIEiazxqsliSyXQvdhStANR2dct53avafmSOO6Rt7RTuNnznYEgVNaSbATDKMek9zrWL4j3h6Fe0FZ7xaF4U2T4FrU2Jxuc4tvpQfgx1TP0e+vS9gYdJUJX8pOjY/63y37GPsgtqGdSdrzAAkJSzL15MmYFB9ZBj+lDjvzd0dFzhxdEnZ4HrHO6T2dKPrylbhHQE1UBvXdecMA1xsoxMxsXMmgks0uMH9rKmKE8JqRyVZiPbB8yHZM3pFnF2ISz8bjwi+Es2WKYe4QfctzeGUOfstEjXVI/iyPtRLtF62tmZFesbXI/Fpid86lZjdadEkm6j58f7uzXP29yNsz0z5ueMLmXNfW9XU7fbui5l4CLbVR0zGLubGTlk1XcAWHmB139yQ/D46Ph8anoqLAx0LurHWdqd09trxjdu37xieRlxD7Gd5e5Nne5xjpybcTV5z/ggm4OLh+vDM4/TeHKqVRTeTJM6Ti++A5OdObp6N3omCMmG9kVjnqrZkSE1DTOx582Vz4QVub7079sRLvw2cLH4Al4H43g4L9//j2kIQQSrpdY6FD1I+1eVdKWmGdUN4q61p/xrmmMUi9c6AL9CKYREo+2gGY+DI60UZcWdAZCXA1eGGUDOrPQpY5EoqWkGsV8WHA0OKFxBURUlXXGldRvBzQ0yQEPRgkWl2BwgQbcnEYyETGPxJk2dFx2IlN0hGNWV44Aq/PkX+rYp+exTCbnE8gBuey6g0wFhcNx1tJayo2KSjMPqf3wdfQlP2/oWYBwMjp6VvPlcjmSeXvkfDnubcP4t+nl5OP1ZMg2jCluDXTEltN+YvdzfOe6tqbw/+yl0/esiPdx3BhJzG77iq/7tnorHnJg9nITGoi+tVJTrLgDk856PZMBv3jTtiymLD2/f+hzIX0+OT9/yABpZPjc0b4hqYjLrvLDG46E1U3Kj5enbyFuwY+N/9Pv1zfcUfs3VO0KtvFySUL+PRN/0V9+yWUIslKWr4Uh0iVZsn7nl9Eid1v4k5ado314VNnVVpQ/XmQFuHHf0L6njS6nyEtuXG37HVRX4xY=
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: eJzdmNuO2zYQQH+F0FMC+LJXp10URbyXFFsEGyPeJA/bfaClsc1EIhVe1usafuuX9NP6JZ0hZUuy5b2g6UOCABtZHA5nhsOZIy4ilYPmVih5mUQnkctTxZPBeX8/akUJmFiLnAZxaKBVDMaAYcaNMmEMvmZqzC6Gw0F/OGQDpS0fpcDOVewykJb191nCLWdjpVmsIcF3gqcMpzouY+iw6ykwDV8dGMsyh3+EjFOXAEvAcpFCwtA4oyRPWyyFCf0HGVo4J/UtxmXClJ5wKYz3gHRLXCzzv5ix2sXW4cKMx1oZg2ukVuRoooGYREwHvbR8YqKTm+iDd531rUVzgoZztD66bUUo7rSwcxRbRCPgGnTf2Sn+vF3icOHCqUpQYhHFSlq0jx55nqci9sq6nw2FcRGZeAoZpyc7zwEDq0af0Ry0JNe0GVaAodE84fvegFKSa83nKCgsZOZpGh6XKndm6ILEo1NEUpHBMAs5QZkQeUoihwJLHzby/Ak2YJrAqdAU0gf0khTpxRcgeQZmWxpHZZELYqX8keCtZuLUVbZd+oCMi527ctkIdONaecrjLcN3xVk5afX8TCXQqEvDRIQM2RqyatY0sPQxvm+cQikM78bvwQh0JoZ+kmg8vf/dzFwZu3MQnwDslXqWFzgibEqvVkaW9g8tn393pjtN2dm8Shjr2x3ZXuypPzcHj3uMUcJnOTmnk/GUowMyeY54BpT6Q9qLT1MRT99ijprUn4o+lbbGI1hx4bDJBZ4kIhzRQc2ZQm6kVApcRhU1R49HIvQFtBXS8UV4Tvo4+Q7LNu35MysBbdKpM0Linl7t2kw6scYC1s/vK0UrkT1+3OSZ0l8GVOeK+U8K5Q5d/LuKE0Xpq6yqEdjZJ9gLlj6G68hcbTSjZ0YlVlnO5Zy0fKQApzsz7iF7Krva+/F2InlyhcuQHB+UDBIoKqTBlZyH3/MdLLFjI9QY6QDe8PsdvoXxwVRJ2CFhxARJBem0sYIW26liwrKCPndyyHI9AaOVI9aGnTvY2/NsVad4RHvGK4zrCT1gP4KycTFB/til6Zy9kIoVMPuSTD5qUniKzFwAcJDZ35b5IDnistLiT/BgeNyk6BIX0sTwBvQdaAZaK+3TIQOcTF8nlGuUoJxaZ9RdfUh0CXS7yLGUAnQIaL7xsO405kI0tTY3J91uou/aIyeTNs0E3SbntEpTfOS56IiJ5tJ2hIqWFegfEq+HiFbRf70LpJxW9WLUv7wQvgkPb1Zp9/una+8NfQe8L78YLu45tiuoE/9NCe+NeE4AHh2O+U/H495R+/jV/qv20XHvoD06HMftg/jn3uG41+Nj3ovqFF7hbEyPg157f6+9fxzVkLo8MRskfbMauX2MlEsVdUCu1ZJSaEW+5ZtQGmqF7746/gDd7lijLFNVLavq9NDKjSD6zVdZMWNl3gYq1qJRAmIdAeu7WqW9+shTwG57QcK5DSp7AndV82abq+ppsIVT3zbQG+DThDY3td74zfc5NPA9KjCb+HCzkwQqi6znb3T7/9HmpCmzQpeNHBbb1xBKWAetj7a6arWc1H2p9dDN1+vWWTG27Jj1b43GLrkWufWdfhy6cAEW5+8/slNsBOxs3QFYf3C5vrryBwGXpD4SShN6f9w56tC1GHUNHurwKgzG5bnS9nXZQdbuit/KV/VuVGk3m3dt60nsxT9//f2SCcM4G84gEWYaOjbcx1MuJ+AvwdDMdQ327RMDyBDj7rA66g67tMz5ezs8o22jUBowlEz42m3nrWK+v7wr241p4ZqJmAiLPXnGMUbWL2ZUKhKWq4RZiKdSpWqC5aLFsH+MUow4zpIwYyncQUr3g8Sonij5SGArmXslyAOKrulQnHI+FdTH2UzYwj2sBS6UI4MKUGUgEu7w09HbmXEp0TcMaorOIvLQdhQh7+ccmzE76OxtxXw2m3W4H+4oPekWc0337eXZxdXwok1zlgXV4hIVpcX1YNPVaOXK78e9JQ2wY+HedrGpC0lJ62O7KHjsJlqZTMWG6KUVFUyGxW5K6IYyi8WIG/ig0+WSXqNXmq5V8fGOa5+C/lYVJwACqfZV8QugSHQWYty+JktIPHX+W2vzipVK65oYB++G14RixdVsFuqf5jPqN/j3JPoD/1HV8Xvp66d/v4hSPF6OT0g+6KW84HX222A9b+3qG1DOK1b+cuoF2LX6AvJXHAg+WfpJJWq5/BeY4DNS
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=a7XYjVKeugSC4&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=MslzbzpUbuDKC&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=Q5TIH1hR82pNM&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=QhwkahQCsAnoQ&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=m45s4x4l4YIFI&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=V1TwdCb7Fs9UP&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=H4S7E04uq1zLp&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=840NBDlEEVdSe&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=ly8nJkQhGT68I&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=vXlzAHzLXfe29&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=vnsgri3lAKzf5&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=RQWbVFYrm1gNW&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=l4Sxb4O9mps38&public=true" target="_blank" rel="noopener noreferrer">View results</a> (<a href="https://www.certification.openid.net/plan-detail.html?plan=40ijlg46LafuE&public=true" target="_blank" rel="noopener noreferrer">PID query</a>) |
| Holder | OID4VP 1.0 + HAIP 1.0, mdoc, direct_post.jwt | <a href="https://www.certification.openid.net/plan-detail.html?plan=AGDtHP8LVp86Z&public=true" target="_blank" rel="noopener noreferrer">View results</a> (<a href="https://www.certification.openid.net/plan-detail.html?plan=bDmgKIz1JpnHU&public=true" target="_blank" rel="noopener noreferrer">mDL query</a>, <a href="https://www.certification.openid.net/plan-detail.html?plan=sLjypjISt7ani&public=true" target="_blank" rel="noopener noreferrer">Photo ID query</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';

<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: Configure the secure vaults of the Organisation Wallet Suite, create signing keys, generate a CSR, get an X.509 certificate, upload the certificate chain and list your keys.
keywords: [key management, signing key, secure vault, Hashicorp Vault, QTSP, CSR, X.509 certificate, certificate chain, x5c, trust list, 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 TestCertificateAuthority, { CSR_CREATED_EVENT } from '@site/src/components/KeyManagement/TestCertificateAuthority';
import UploadCertificateChain, { KEY_CREATED_EVENT } from '@site/src/components/KeyManagement/UploadCertificateChain';
import { refreshOrganisationKeys } from '@site/src/hooks/useOrganisationSigningKey';

The Organisation Wallet Suite signs with the keys of your organisation. A key has one of four purposes, and you set each one in a different request:

| Key | What it signs | Where you set it | Certificate profile |
|---|---|---|---|
| Credential signing key | The credentials that you issue (SD-JWT VC, W3C VC, mso_mdoc) | Credential definition: `cryptographicKeyFormat` and `cryptographicKeyIdentifier`, for the whole definition or for one entry of `credentialDefinitions` | Credential issuer; mdoc issuer (Document Signer) for `mso_mdoc` |
| Status list signing key | The status list token that tells verifiers if a credential is revoked or suspended | Credential definition, in an entry of `credentialDefinitions`: `statusListCryptographicKeyFormat` and `statusListCryptographicKeyIdentifier`. Leave them out to use the credential signing key | Credential issuer. For `mso_mdoc`: `x509` from the same CA as the Document Signer, without extended key usage (ISO/IEC 18013-5 Table B.9) |
| Verification request signing key | The OpenID4VP request object of a verifier | Presentation definition: `cryptographicKeyFormat` and `cryptographicKeyIdentifier` | Relying party (WRPAC); mdoc verifier for ISO/IEC 18013-7 Annex C |
| Issuer metadata signing key | The Credential Issuer Metadata, when you publish it signed (`signed_metadata`) | Global configuration: `issuerMetadata.signedMetadataEnabled`, `issuerMetadata.cryptographicKeyFormat` and `issuerMetadata.cryptographicKeyIdentifier` | Credential issuer |

Each key signs with `did:key` or with `x509`. With `x509` the signature carries the certificate chain (`x5c`), and EUDI Wallets check it against a trust list: an issuer list (EAA, QEAA, Pub-EAA or PID) for the credential, status list and metadata keys, and the WRPAC list for the verification request key. When the certificate is on the list, the wallet shows your organisation as trusted. Use `did:key` for tests only. `mso_mdoc` always needs `x509`.

**Choosing a key in a workflow:** in the request panels of the developer guides, each signing key field has a key label next to it, for example **Credential signing key** after `cryptographicKeyIdentifier`. Click it to list the keys from Step 7, see which have a certificate and its profile, and write the key into that field and its format field. A credential definition can have a different key for each purpose. Hover a field name to see what the field does.

This guide creates a key and gives it a certificate:

1. Configure the secure vaults that hold the keys.
2. Create a key.
3. Generate a certificate signing request (CSR) for the key.
4. Get an X.509 certificate for the CSR, with the profile of the purpose.
5. Upload the certificate chain to the key.
6. List the keys and check which ones have a certificate.
7. Register the certificate in a trust list.

### Step 1: Get the API Key (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 />

### Step 2: Configure the Secure Vaults (Admin)

A secure vault holds the private keys. The private key never leaves the vault: the API returns public keys only. Your organisation can use these vaults:

| Key management service | Use it when |
|---|---|
| Local Vault | You want the platform to hold the keys. Always enabled. |
| External Vault | Your keys are in your own Hashicorp Vault. |
| Qualified Trust Service Provider (QTSP) | You sign qualified electronic signatures with a QTSP over the Cloud Signature Consortium (CSC) API. |

Read the current configuration first. Then select a sample, change it to your values, and run it. Every organisation starts with the Local Vault, so this step uses the [Update Secure Vault](/docs/openid4vc-api/config-digital-wallet-open-id-update-secure-vault/) API (`PUT`). The [Configure Secure Vault](/docs/openid4vc-api/config-digital-wallet-open-id-configure-secure-vault/) API (`POST`) works only for an organisation without a vault configuration.

**Read the configuration**

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management"
  method="GET"
  initialJsonData={{}}
/>

**Update the vaults**

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management"
  method="PUT"
  jsonOptionLabel="Vault setup"
  jsonOptions={[
    {
      value: 'local',
      label: 'Local Vault only',
      json: {
        igrantioVault: { enabled: true },
        hashicorpVault: { enabled: false },
        qtsp: { enabled: false },
      },
    },
    {
      value: 'hashicorp',
      label: 'Local Vault and External Vault (Hashicorp)',
      json: {
        igrantioVault: { enabled: true },
        hashicorpVault: {
          enabled: true,
          vaultAddress: 'https://vault.example.com:8200',
          vaultNamespace: '<yourNamespace>',
          vaultUsername: '<yourUsername>',
          vaultPassword: '<yourPassword>',
        },
        qtsp: { enabled: false },
      },
    },
    {
      value: 'qtsp',
      label: 'Local Vault and Qualified Trust Service Provider (CSC API)',
      json: {
        igrantioVault: { enabled: true },
        hashicorpVault: { enabled: false },
        qtsp: {
          enabled: true,
          cscUrl: 'https://csc.example-qtsp.eu/csc/v2',
          cscApiVersion: 'v2',
          clientId: '<yourClientId>',
          clientSecret: '<yourClientSecret>',
          userID: '<yourUserId>',
        },
      },
    },
  ]}
/>

For a QTSP, select the signing credential after this step with the [List QTSP Credentials](/docs/openid4vc-api/config-digital-wallet-open-id-list-qtsp-credential/) and [Configure QTSP Credential](/docs/openid4vc-api/config-digital-wallet-open-id-configure-qtsp-credential/) APIs. The QTSP holds that key, so Steps 3 to 5 do not apply to it.

### Step 3: Create a Key (Admin)

Create an ECDSA P-256 key in the Local Vault (`vaultType` `1`). The API does not create keys in an External Vault or at a QTSP. The vault sets the key type, the curve (`P-256`) and the algorithm (`ES256`). Run the request. Alternatively, use the [Create Key](/docs/openid4vc-api/config-digital-wallet-open-id-create-key/) API. The response has the `keyId`, which the next steps fill in for you.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys"
  method="POST"
  initialJsonData={{ vaultType: 1 }}
  emitResultEvent={KEY_CREATED_EVENT}
  extractResultEvent={(result) => (result?.keyId ? { keyId: result.keyId } : null)}
  onSuccess={refreshOrganisationKeys}
/>

### Step 4: Generate a CSR (Admin)

The certificate signing request (CSR) carries the public key of the key from Step 3 and the details of your organisation. `commonName` is required. `organization`, `country` (2 letter code), `sanDns` and `sanUri` are optional in the API, but give `country`: the certificate profiles below need it, and ISO/IEC 18013-5 requires it for mdoc. Put the domain of your service in `sanDns`: the `x509_san_dns` client ID prefix of OpenID4VP needs it. Alternatively, use the [Generate CSR](/docs/openid4vc-api/config-digital-wallet-open-id-generate-csr/) API.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys/{keyId}/csr"
  method="POST"
  listenPathParamsEvent={KEY_CREATED_EVENT}
  initialJsonData={{
    commonName: 'My Organisation',
    organization: 'My Organisation',
    country: 'SE',
    sanDns: ['verifier.example.com'],
    sanUri: ['https://verifier.example.com'],
  }}
  emitResultEvent={CSR_CREATED_EVENT}
  extractResultEvent={(result) => (result?.csr ? { csr: result.csr } : null)}
/>

### Step 5: Get a Certificate for the CSR

For production, send the CSR to your Certificate Authority (CA) or QTSP, and ask for the certificate profile of your use. For tests, use one of the two options below. Both give a chain with the leaf certificate first, then the CA certificate. That is the order that Step 6 needs.

Select the certificate profile for what the key signs:

| Profile | Use the key for | Extensions of the leaf certificate |
|---|---|---|
| Credential issuer | SD-JWT VC and W3C VC credentials (PID, EAA, QEAA, Pub-EAA), status lists, signed issuer metadata | Base set |
| mdoc issuer | `mso_mdoc` credentials, such as mDL (ISO/IEC 18013-5 Document Signer) | Base set, extended key usage `1.0.18013.5.1.2` (critical), CRL distribution point |
| Relying party | Signed OpenID4VP requests of a verifier (WRPAC, ETSI TS 119 411-8) | Base set, extended key usage `clientAuth`, certificate policy `0.4.0.194118.1.2` |
| mdoc verifier | ISO/IEC 18013-7 Annex C requests (ISO/IEC 18013-5 reader authentication) | Base set, extended key usage `1.0.18013.5.1.6` (critical) |
| mdoc status list signer | Status lists of `mso_mdoc` credentials (ISO/IEC 18013-5 Table B.9) | Base set, signed by the same CA as the Document Signer. Use the credential issuer profile |

The base set for every profile: key usage `digitalSignature` (critical), subject and authority key identifiers, the subject alternative names of the CSR, an issuer alternative name with a contact email, and no basic constraints. The test CA has the shape of an ISO/IEC 18013-5 IACA root: country in the subject, basic constraints `CA:TRUE` with path length 0, key usage `keyCertSign` and `cRLSign`, and an issuer alternative name. The leaf is valid for 397 days, within the 457 days that ISO/IEC 18013-5 allows a Document Signer.

**Option A: test CA in your browser**

Select the profile and choose **Sign CSR**. The page creates a test CA in your browser and signs the CSR from Step 4 with it. Every key that you sign on this page chains to the same test CA, until you reload the page. Nothing leaves the page.

<NoteBox title="Note:" variant="caution">
The test CA is for tests only. Wallets do not trust it, and the CA key is gone when you reload the page. Download <code>test-ca.pem</code> if you want to keep the CA certificate.
</NoteBox>

<TestCertificateAuthority />

**Option B: test CA on your machine with OpenSSL 3**

Save the CSR from Step 4 as `request.csr`, then run:

```bash
# 1. Create a test CA (once), in the shape of an ISO/IEC 18013-5 IACA root.
#    Use the country of your CSR.
openssl ecparam -name prime256v1 -genkey -noout -out test-ca.key
openssl req -x509 -new -key test-ca.key -sha256 -days 825 -out test-ca.pem \
  -subj "/C=SE/CN=My Test CA" \
  -addext "basicConstraints=critical,CA:TRUE,pathlen:0" \
  -addext "keyUsage=critical,keyCertSign,cRLSign" \
  -addext "subjectKeyIdentifier=hash" \
  -addext "issuerAltName=email:admin@example.com"

# 2. The base set of extensions for every leaf certificate
cat > leaf.ext <<'EXT'
keyUsage=critical,digitalSignature
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid
issuerAltName=email:admin@example.com
EXT

# 3. Add the lines of your profile to leaf.ext (credential issuer: add nothing)
# mdoc issuer (Document Signer):
#   extendedKeyUsage=critical,1.0.18013.5.1.2
#   crlDistributionPoints=URI:https://example.com/crl/test-ca.crl
# Relying party (WRPAC):
#   extendedKeyUsage=clientAuth
#   certificatePolicies=0.4.0.194118.1.2
# mdoc verifier (reader authentication):
#   extendedKeyUsage=critical,1.0.18013.5.1.6

# 4. Check the CSR, then sign it. -copy_extensions keeps the subject alternative names of the CSR.
openssl req -in request.csr -noout -verify
openssl x509 -req -in request.csr -CA test-ca.pem -CAkey test-ca.key -CAcreateserial \
  -days 397 -sha256 -copy_extensions copy -extfile leaf.ext -out leaf.pem

# 5. Build the chain: leaf first, then the CA. Then check it.
cat leaf.pem test-ca.pem > chain.pem
openssl verify -CAfile test-ca.pem leaf.pem
openssl x509 -in leaf.pem -noout -text
```

### Step 6: Upload the Certificate Chain (Admin)

Upload the chain to the key. The key ID and the chain from the earlier steps are filled in for you; you can also paste your own. The file must be PEM text with the leaf certificate first, then the intermediate certificates, then the root certificate. Alternatively, use the [Upload Certificate Chain](/docs/openid4vc-api/config-digital-wallet-open-id-upload-certificate-chain/) API.

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.

<UploadCertificateChain />

The same request with curl:

```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"
```

The response has `key_id`, `certificates_count`, `x5t` and `x5t_s256`. The key now has the chain as its `x5c` value.

### Step 7: List the Keys (Admin)

List the keys of all vaults. Each key has its public JWK, `isDefault` (the wallet signs with this key by default) and its DIDs. A key with a certificate chain has `x5c`, `x5t` and `x5t#S256` in its JWK. Alternatively, use the [List Keys](/docs/openid4vc-api/config-digital-wallet-open-id-list-keys/) API.

<DcqlStepTemplate
  endpointPath="/v2/config/digital-wallet/openid/key-management/keys"
  method="GET"
  initialJsonData={{}}
/>

### Step 8: Register the Certificate in a Trust List

A wallet trusts your organisation when your certificate is on a trust list. To add your certificate to 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). Use the leaf certificate from Step 5. To learn how trust lists work, see [Trust in the Wallet Ecosystem](/docs/trust-overview/).

| You are | Trust list |
|---|---|
| Issuer of (Q)EAAs, Pub-EAAs or PIDs | EAA, QEAA, Pub-EAA or PID list |
| Verifier (relying party) | Wallet-Relying Party Access Certificate (WRPAC) list |


---

# Organisation Wallet Suite - On-Premise Deployment Instructions
Source: https://docs.igrant.io/docs/organisation-wallet-on-premise-deployment/

---
id: eo-ow-on-premise-deployment
title: Organisation Wallet Suite - On-Premise Deployment Instructions
description: Developer user guide for deploying the Organisation Wallet Suite using the official Helm chart.
hide_title: false
sidebar_label: Deployment Guide
keywords: [on-premise deployment, Helm chart, Organisation Wallet, European Business Wallet, Kubernetes, self-hosted, installation, deployment guide]
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 Instructions | iGrant.io DevDocs</title>
  <meta name="description" content="Developer user guide for deploying the Organisation Wallet Suite using the official Helm chart." />
</head>

The Helm chart for Organisation Wallet Suite by iGrant.io enables the issuer, holder, and verifier of verifiable credentials within the eIDAS 2.0 framework. It incorporates the latest amendments, the EU Architectural Reference Framework (ARF), and Implementing Acts (IA).

## About

This page provides Helm charts for deploying the Organisation Wallet Suite by iGrant.io on Kubernetes. The Organisation Wallet Suite enables organizations to issue, hold, and verify credentials in compliance with the European Digital Identity framework.

## Requirements

| Requirement | Version      |
| ----------- | ------------ |
| Kubernetes  | `>=1.20.0-0` |
| Helm        | `>=3.0.0`    |

## Hardware Requirements

The software requires a Kubernetes-compatible Linux environment. Resource requirements vary by deployment type.

### Development / Single-Node Deployment

| Component        | Minimum Requirement                    |
| ---------------- | -------------------------------------- |
| CPU              | 4 vCPU                                 |
| Memory           | 8 GB RAM                               |
| Storage          | 80 GB SSD (NVMe or equivalent)         |
| Network          | 1 Gbit/s connectivity                  |
| Architecture     | x86_64                                 |
| Operating System | Linux (e.g., Ubuntu LTS or equivalent) |

Storage must be SSD-backed. Local storage is sufficient for development environments.

### Production Deployment (High Availability)

| Component        | Minimum Requirement                             |
| ---------------- | ----------------------------------------------- |
| CPU              | 16 vCPU (per node)                              |
| Memory           | 32 GB RAM (per node)                            |
| Storage          | 256 GB SSD (NVMe or equivalent, per node)       |
| Network          | 10 Gbit/s connectivity                          |
| Nodes            | Minimum 3 nodes                                 |
| Architecture     | x86_64                                          |
| Operating System | Linux (e.g., Ubuntu LTS or equivalent)          |

Production environments require redundant storage, multi-node high availability, and dedicated persistent volumes.

<NoteBox title="Note:" variant="note">
Resource requirements may increase depending on transaction volume, credential issuance rates, and concurrent API usage.
</NoteBox>

## Quick Start

### Add Helm Repository

```bash
helm repo add organisationwallet https://l3-iGrant.github.io/helmcharts/stable/
helm repo update
```

### Install Chart

```bash
helm install [RELEASE_NAME] organisationwallet/organisationwallet --version 2026.1.3
```

To install with a custom values file:

```bash
helm install [RELEASE_NAME] organisationwallet/organisationwallet --version 2026.1.3 --values values.yaml
```

### Uninstall Chart

```bash
helm uninstall [RELEASE_NAME]
```

This removes all Kubernetes components associated with the chart and deletes the release.

## Configuration

To view all configurable options:

```bash
helm show values organisationwallet/organisationwallet
```

### Global Configuration

| Parameter                        | Description                            | Default      |
| -------------------------------- | -------------------------------------- | ------------ |
| `namespace`                      | Kubernetes namespace                   | `ig`         |
| `prefix`                         | Prefix for Kubernetes object names     | `""`         |
| `resources`                      | Resource constraints for pods          | `{}`         |
| `securityContext.runAsNonRoot`   | Run containers as a non-root user      | `true`       |
| `securityContext.runAsUser`      | User ID to run containers              | `1001`       |
| `securityContext.fsGroup`        | Filesystem group                       | `1001`       |
| `securityContext.allowPrivilegeEscalation` | Disallow privilege escalation | `false`      |
| `storageClassName`               | Storage class for persistent volumes   | `local-path` |

All components run as non-root and are compatible with the OpenShift restricted-v2 Security Context Constraint (no privileged containers, no privilege escalation).

```yaml
namespace: ig
prefix:
resources: {}
securityContext:
  runAsNonRoot: true
  runAsUser: 1001
  runAsGroup: 1001
  fsGroup: 1001
  allowPrivilegeEscalation: false
  seccompProfile:
    type: RuntimeDefault
storageClassName: local-path
```

### OpenShift deployment

The chart is supported on the Red Hat OpenShift Container Platform (4.x). Every container image runs as a non-root user under the default `restricted-v2` Security Context Constraint, writes only to declared volumes, and drops privilege escalation. No `SecurityContextConstraints` change or `anyuid` grant is required.

### PostgreSQL

PostgreSQL is used as the database backend for Keycloak.

| Parameter           | Description                  | Default                                                                              |
| ------------------- | ---------------------------- | ------------------------------------------------------------------------------------ |
| `postgres.enabled`  | Enable PostgreSQL deployment | `true`                                                                               |
| `postgres.image`    | Container image              | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/postgres:2025.1.1` |
| `postgres.username` | Database username            | `dbadmin`                                                                            |
| `postgres.password` | Database password            | `<your-password>`                                                                    |
| `postgres.database` | Database name                | `kcdb`                                                                               |

```yaml
postgres:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/postgres:2025.1.1
  username: dbadmin
  password: <your-password>
  database: kcdb
```

### Keycloak

Keycloak provides identity and access management.

| Parameter                  | Description                | Default                                                                                         |
| -------------------------- | -------------------------- | ----------------------------------------------------------------------------------------------- |
| `keycloak.enabled`         | Enable Keycloak deployment | `true`                                                                                          |
| `keycloak.image`           | Container image            | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/keycloak:26.0.7-debian-12-r0` |
| `keycloak.adminUsername`   | Admin username             | `kcadmin`                                                                                       |
| `keycloak.adminPassword`   | Admin password             | `<your-password>`                                                                               |
| `keycloak.dbUsername`      | Database username          | `dbadmin`                                                                                       |
| `keycloak.dbPassword`      | Database password          | `<your-password>`                                                                               |
| `keycloak.dbName`          | Database name              | `kcdb`                                                                                          |
| `keycloak.frontendUrl`     | Frontend URL               | `https://keycloak.example.com`                                                                  |
| `keycloak.ingress.enabled` | Enable ingress             | `true`                                                                                          |

```yaml
keycloak:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/keycloak:26.0.7-debian-12-r0
  adminUsername: kcadmin
  adminPassword: <your-password>
  dbUsername: dbadmin
  dbPassword: <your-password>
  dbName: kcdb
  frontendUrl: https://keycloak.example.com
  ingress:
    enabled: true
    annotations:
      kubernetes.io/ingress.allow-http: "false"
      kubernetes.io/ingress.class: nginx
      nginx.ingress.kubernetes.io/enable-cors: "true"
      nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
      cert-manager.io/cluster-issuer: "letsencrypt-prod"
      kubernetes.io/tls-acme: "true"
      nginx.ingress.kubernetes.io/proxy-set-headers: |
        X-Forwarded-Proto https
        X-Forwarded-Port 443
    hosts:
      - host: keycloak.example.com
        paths:
          - path: /
            pathType: Prefix
    tls:
      - hosts:
          - keycloak.example.com
        secretName: keycloak-tls
```

### MongoDB

MongoDB is used as the primary database for the Organisation Wallet Suite.

| Parameter        | Description               | Default                                                                                  |
| ---------------- | ------------------------- | ---------------------------------------------------------------------------------------- |
| `mongo.enabled`  | Enable MongoDB deployment | `true`                                                                                   |
| `mongo.image`    | Container image           | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/mongodb:7.0-debian-12` |
| `mongo.username` | Database username         | `dbadmin`                                                                                |
| `mongo.password` | Database password         | `<your-password>`                                                                        |
| `mongo.database` | Database name             | `owsdb`                                                                                  |

```yaml
mongo:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/mongodb:7.0-debian-12
  username: dbadmin
  password: <your-password>
  database: owsdb
```

### MariaDB / MySQL (Relational Database)

For on-premise deployments that mandate a relational database, the Organisation Wallet Suite can be configured to use a MySQL/MariaDB relational store for LPID and related data. MariaDB is MySQL wire-compatible, so either engine may be used. Credentials should be supplied through a Kubernetes secret rather than in the values file.

| Parameter           | Description                  | Default                                                                                   |
| ------------------- | ---------------------------- | ----------------------------------------------------------------------------------------- |
| `mariadb.enabled`   | Enable MariaDB/MySQL         | `true`                                                                                    |
| `mariadb.image`     | Container image              | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/mariadb:11.4-debian-12` |
| `mariadb.username`  | Database username            | `dbadmin`                                                                                 |
| `mariadb.password`  | Database password (secret)   | `<your-password>`                                                                         |
| `mariadb.database`  | Database name                | `owsreldb`                                                                                |

```yaml
mariadb:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/mariadb:11.4-debian-12
  username: dbadmin
  password: <your-password>
  database: owsreldb
```

### NATS

NATS provides messaging and event streaming capabilities.

| Parameter      | Description            | Default               |
| -------------- | ---------------------- | --------------------- |
| `nats.enabled` | Enable NATS deployment | `true`                |
| `nats.image`   | Container image        | `nats:2.10.14-alpine` |

```yaml
nats:
  enabled: true
  image: nats:2.10.14-alpine
```

<NoteBox title="Note:" variant="note">
NATS is the internal inter-service event bus only. It is not exposed to external systems and is not used for external message-queue integrations. External message-queue intake (for example, inbound revocation instructions) uses the RabbitMQ adapter below.
</NoteBox>

### RabbitMQ (Message Queue Adapter)

The Organisation Wallet Suite can consume instructions from an external message queue through a RabbitMQ (AMQP) adapter. This is used, for example, to receive revocation instructions and related data produced by an external system, which are then fed into the shared revocation processing path. Delivery is durable and acknowledged, with automatic retry and dead-letter handling. The transport is configurable, so the queue name and protocol can be set to whatever the integrating system nominates.

| Parameter                | Description                                | Default                                                                                    |
| ------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `rabbitmq.enabled`       | Enable RabbitMQ adapter                     | `true`                                                                                     |
| `rabbitmq.image`         | Container image                             | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/rabbitmq:3.13-debian-12` |
| `rabbitmq.username`      | Broker username                             | `rabbit`                                                                                   |
| `rabbitmq.password`      | Broker password (secret)                    | `<your-password>`                                                                          |
| `rabbitmq.revocationQueue` | Queue consumed for revocation instructions | `prh.lpid.revocation`                                                                      |

```yaml
rabbitmq:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/rabbitmq:3.13-debian-12
  username: rabbit
  password: <your-password>
  revocationQueue: prh.lpid.revocation
```

### API

The API service provides the backend for the Organisation Wallet Suite.

| Parameter                        | Description             | Default                                                                         |
| -------------------------------- | ----------------------- | ------------------------------------------------------------------------------- |
| `api.enabled`                    | Enable API deployment   | `true`                                                                          |
| `api.imagePullSecret`            | Image pull secret name  | `""`                                                                            |
| `api.image`                      | Container image         | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/api:2026.1.1` |
| `api.ingress.enabled`            | Enable ingress          | `true`                                                                          |
| `api.configuration.ApiSecretKey` | API secret key for JWT  | `<your-secret>`                                                                 |
| `api.configuration.Iam.url`      | Keycloak URL            | `""`                                                                            |
| `api.configuration.Iam.realm`    | Keycloak realm          | `igrant-users`                                                                  |
| `api.configuration.Iam.ClientId` | Keycloak client ID      | `igrant-ios-app`                                                                |
| `api.configuration.Nats.url`     | NATS server URL         | `""`                                                                            |
| `api.configuration.Nats.timeout` | NATS connection timeout | `5`                                                                             |

```yaml
api:
  enabled: true
  imagePullSecret:
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/api:2026.1.1
  ingress:
    enabled: true
    annotations:
      kubernetes.io/ingress.allow-http: "false"
      kubernetes.io/ingress.class: nginx
      nginx.ingress.kubernetes.io/enable-cors: "true"
      nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
      cert-manager.io/cluster-issuer: "letsencrypt-prod"
      kubernetes.io/tls-acme: "true"
    hosts:
      - host: api.example.com
        paths:
          - path: /
            pathType: Prefix
    tls:
      - hosts:
          - api.example.com
        secretName: api-tls
  configuration:
    database:
      host:
    ApiSecretKey: <your-secret>
    Iam:
      url: https://keycloak.example.com/auth
      realm: igrant-users
      ClientId: igrant-ios-app
    Nats:
      url:
      timeout: 5
```

### Vault Facade

The Vault Facade provides a unified interface for secrets management. It supports two modes:
- **vault** (Required for production and regulated deployments): Uses HashiCorp Vault for production-grade secrets management. This is the mode used for all production, test and acceptance environments; it should be fixed in the deployment runbook rather than left to a values-file default.
- **mongo** (Local development only): Uses MongoDB for storing secrets. Not used in production or regulated environments.

| Parameter                     | Description                               | Default                                                                                  |
| ----------------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------- |
| `vaultFacade.enabled`         | Enable Vault Facade deployment            | `true`                                                                                   |
| `vaultFacade.imagePullSecret` | Image pull secret name                    | `""`                                                                                     |
| `vaultFacade.image`           | Container image                           | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/vault-facade:2026.1.1` |
| `vaultFacade.appMode`         | Application mode (`mongo` or `vault`)     | `mongo`                                                                                  |
| `vaultFacade.vault.addr`      | Vault server address (when appMode=vault) | `""`                                                                                     |
| `vaultFacade.vault.user`      | Vault username (when appMode=vault)       | `""`                                                                                     |
| `vaultFacade.vault.password`  | Vault password (when appMode=vault)       | `""`                                                                                     |

```yaml
vaultFacade:
  enabled: true
  imagePullSecret:
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/vault-facade:2026.1.1
  appMode: mongo
  vault:
    addr:
    user:
    password:
```

### Organisation Wallet Service

The core Organisation Wallet service.

| Parameter                                    | Description                           | Default                                                                         |
| -------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------- |
| `organisationWallet.enabled`                 | Enable Organisation Wallet deployment | `true`                                                                          |
| `organisationWallet.imagePullSecret`         | Image pull secret name                | `""`                                                                            |
| `organisationWallet.image`                   | Container image                       | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/ows:2026.1.5` |
| `organisationWallet.dbName`                  | Database name                         | `walletdb`                                                                      |
| `organisationWallet.service.ingress.enabled` | Enable ingress                        | `true`                                                                          |

```yaml
organisationWallet:
  enabled: true
  imagePullSecret:
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/ows:2026.1.5
  dbName: walletdb
  service:
    ingress:
      enabled: true
      annotations:
        kubernetes.io/ingress.allow-http: "false"
        kubernetes.io/ingress.class: nginx
        nginx.ingress.kubernetes.io/enable-cors: "true"
        nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
        cert-manager.io/cluster-issuer: "letsencrypt-prod"
        kubernetes.io/tls-acme: "true"
      hosts:
        - host: wallet.example.com
          paths:
            - path: /
              pathType: Prefix
      tls:
        - hosts:
            - wallet.example.com
          secretName: wallet-tls
```

### Enterprise Dashboard

The web-based administration dashboard.

| Parameter                             | Description                            | Default                                                                               |
| ------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------- |
| `enterpriseDashboard.enabled`         | Enable Enterprise Dashboard deployment | `true`                                                                                |
| `enterpriseDashboard.imagePullSecret` | Image pull secret name                 | `""`                                                                                  |
| `enterpriseDashboard.image`           | Container image                        | `europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/dashboard:2026.1.1` |
| `enterpriseDashboard.ingress.enabled` | Enable ingress                         | `true`                                                                                |

```yaml
enterpriseDashboard:
  enabled: true
  imagePullSecret:
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/dashboard:2026.1.1
  ingress:
    enabled: true
    annotations:
      kubernetes.io/ingress.allow-http: "false"
      kubernetes.io/ingress.class: nginx
      nginx.ingress.kubernetes.io/enable-cors: "true"
      nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
      cert-manager.io/cluster-issuer: "letsencrypt-prod"
      kubernetes.io/tls-acme: "true"
    hosts:
      - host: dashboard.example.com
        paths:
          - path: /
            pathType: Prefix
    tls:
      - hosts:
          - dashboard.example.com
        secretName: dashboard-tls
```

## Secrets Management

The Organisation Wallet Suite supports two modes for secrets management via the Vault Facade service.

### MongoDB-based Vault (Recommended for Development)

For development and testing environments, the MongoDB-based vault is recommended. This mode stores secrets directly in MongoDB, simplifying the deployment without requiring external dependencies.

To enable MongoDB-based vault:

```yaml
vaultFacade:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/vault-facade:2026.1.1
  appMode: mongo
```

This configuration uses the existing MongoDB deployment for secrets storage, making it ideal for:
- Local development environments
- Testing and staging deployments
- Quick proof-of-concept setups

### HashiCorp Vault (Optional - Production)

For production environments requiring enterprise-grade secrets management, HashiCorp Vault can be used as an optional backend.

#### Prerequisites

Install HashiCorp Vault using the official Helm chart:

```bash
# Add HashiCorp Helm repository
helm repo add hashicorp https://helm.releases.hashicorp.com
helm repo update

# Install Vault with HA and Raft storage
helm upgrade --install vault hashicorp/vault \
  --namespace vault \
  --create-namespace \
  -f vault-values.yaml
```

Create a `vault-values.yaml` file:

```yaml
server:
  affinity: ""
  ha:
    enabled: true
    raft:
      enabled: true
      setNodeId: true
      config: |
        ui = true
        cluster_name = "vault-integrated-storage"
        storage "raft" {
          path = "/vault/data/"
        }
        listener "tcp" {
          address = "[::]:8200"
          cluster_address = "[::]:8201"
          tls_disable = "true"
        }
        service_registration "kubernetes" {}
```

#### Initialize and Unseal Vault

```bash
# Initialize Vault (only needed once)
kubectl exec -n vault vault-0 -- vault operator init

# Store the unseal keys and root token securely
# Unseal Vault using the unseal keys
kubectl exec -n vault vault-0 -- vault operator unseal <unseal-key-1>
kubectl exec -n vault vault-0 -- vault operator unseal <unseal-key-2>
kubectl exec -n vault vault-0 -- vault operator unseal <unseal-key-3>
```

#### Configure Vault Facade for HashiCorp Vault

```yaml
vaultFacade:
  enabled: true
  image: europe-docker.pkg.dev/jenkins-189019/igrant-customers/igrant-api/vault-facade:2026.1.1
  appMode: vault
  vault:
    addr: http://vault.vault.svc.cluster.local:8200
    user: <vault-username>
    password: <vault-password>
```

For more information, see the [Vault Helm documentation](https://developer.hashicorp.com/vault/docs/platform/k8s/helm).

## Onboarding Organisations

After deploying the Organisation Wallet Suite, you need to initialize a wallet provider organisation and tenant organisations. This is done using the setup script included in the Organisation Wallet Config service.

### Running the Setup Script

1. Access the Organisation Wallet Config service container:

```bash
# For Kubernetes
kubectl exec -it <ows-config-pod-name> -n <namespace> -- /bin/bash

# For Docker Compose
docker compose exec organisation-wallet /bin/bash
```

2. Navigate to the scripts folder and run the setup script:

```bash
cd scripts
uv run setup_organisations.py --config sample_config.yaml
```

### Sample Configuration

Create a configuration file (e.g., `sample_config.yaml`) with the following structure:

```yaml
# Organisation type to create/use
organisationType: "Technology"

# List of organisations to set up
organisations:
  # Wallet Provider Organisation
  - admin:
      email: "walletprovider@example.com"
      name: "Wallet Provider"
      password: "<your-password>"
      phone: "+1234567890"

    organisation:
      name: "Wallet Provider Organisation"
      location: "Sweden"
      description: "Wallet provider organisation description. Contact our DPO at dpo@example.com for data-related queries."
      policyUrl: "https://example.com/privacy.html"

    # Enable this organisation as a wallet provider
    isWalletProvider: true

    # Vault type for key management
    vaultType: "igrantioVault"

    # Custom wallet features (optional)
    features:
      gettingStarted: true
      dataAgreements: false
      managedData: false
      digitalWalletAries: false
      digitalWalletOid4vc: true
      manageUsers: false
      privacyDashboard: false
      account: true
      supportEvents: true

    # Credential definitions to create
    credentialDefinitions:
      - label: "Wallet Unit Attestation"
        expirationInDays: 30
        supportRevocation: true
        display:
          name: "Wallet Unit Attestation"
          description: "Attests the security context of a wallet unit"
          backgroundColor: "#1E3A5F"
          textColor: "#FFFFFF"
        credentialFormat: "dc+sd-jwt"
        vct: "WalletUnitAttestation"
        version: "draft_13"
        claims:
          type: "object"
          properties:
            attested_security_context:
              type: "string"
              limitDisclosure: false
          additionalProperties: true
          required:
            - "attested_security_context"
        credentialBindingMethods:
          - "did:key"

  # Tenant Organisation
  - admin:
      email: "admin@tenant.com"
      name: "Tenant Admin"
      password: "<your-password>"
      phone: "+1234567891"

    organisation:
      name: "Tenant Organisation"
      location: "Berlin"
      description: "Tenant organisation description. Contact our DPO for data-related queries."
      policyUrl: "https://tenant.com/policy.html"

    isWalletProvider: false
    createWalletUnit: true
    vaultType: "igrantioVault"
```

### Configuration Options

| Field                      | Description                               | Required |
| -------------------------- | ----------------------------------------- | -------- |
| `organisationType`         | Type of organisation (e.g., "Technology") | Yes      |
| `admin.email`              | Admin user email                          | Yes      |
| `admin.name`               | Admin user name                           | Yes      |
| `admin.password`           | Admin user password                       | Yes      |
| `organisation.name`        | Organisation name                         | Yes      |
| `organisation.location`    | Organisation location                     | Yes      |
| `organisation.description` | Organisation description                  | Yes      |
| `organisation.policyUrl`   | Privacy policy URL                        | Yes      |
| `isWalletProvider`         | Set to `true` for wallet provider org     | Yes      |
| `createWalletUnit`         | Create wallet unit for tenant orgs        | No       |
| `vaultType`                | Vault type (`igrantioVault`)              | Yes      |
| `features`                 | Feature flags for the organisation        | No       |
| `credentialDefinitions`    | Credential definitions to create          | No       |

## References

[1] Organisation Wallet Suite Helm chart (Artifact Hub): [https://artifacthub.io/packages/helm/organisationwallet/organisationwallet](https://artifacthub.io/packages/helm/organisationwallet/organisationwallet)

[2] Helm charts repository: [https://github.com/L3-iGrant/helmcharts](https://github.com/L3-iGrant/helmcharts)

[3] Organisation Wallet Suite overview: [https://docs.igrant.io/docs/organisation-wallet-overview/](https://docs.igrant.io/docs/organisation-wallet-overview/)

[4] 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.

### 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: eJzlVsFuGzcQ/ZXBnhJA2lUc92IEQW3LLtQGjQE5zcEwYGp3JDGiSJbkWlYE3fol/bR+SWfIlbSS5SSH3nqxVyRn+ObN4yNXWYW+dNIGaXR2ln2yyojKg4Cb/jWMpUIYGwe1R5AaPlrUg/7pHzcQnNBelBwFlQgCvJxoqSewMG42Vmbh86yTGYtO8JpBRblLo8dyculQBOzLiQxCfRZKYYhpq7T1NW1JkQ7/rNGHC1Mts7NV/CkdUpbgauxwqoA68NS8VkFa4UJBQOddBsPDvpziPH6FpUXa3Yy+YBkotXUMK0j0PMsltlb54KgKWsXJBG2QjaQWbpmt150WirsUd79ep3FvjfYp4Umvx//2aeWqoI4FYgW+Lkv0flwrtcz2ihHWKllGyoovnkN/vBJZfbOOuqYFBJaBazE/UnQzefUU0GmhPkg9+3ZGJ5/RQnu0tjiS8D4yNkUiwjFs/nXae8Mb/TAP7Q3ROeMuTcWbxe9+i/j7znc420XvCpWEYoKO8z2JuWV5nPZ66yPpj5CzDckuREVHxtYBSJxEBnGQrZNeDo6cFnWYGie/IpO3T81PSU3/U2oGOikHPLpHdBC3OeCIgjyWpMVATnG3ys6t/A35837dWWUXKBy6cyI4jnDVYuKZnb4p6zlxCsPkXMwIQZkatiprfGREcFxWPL4tknkVSFrWnrmvmvhu43wFS71IZzxjTIzYR0j7RfVxbpqCaF3tFI1NQ7D+rCgqmusKK3M5IYMNuTQZV7Gf4MaZqk7W+0Ka72UYEgls1i+E+zR9COR+x/SQBZd0suF723CRBjqkFs4ZW0W/kudk543Wo4Czw4af3wxghkvgE0HcNjrP4XaK8ChUjWDGQFPwsJfnAdI2MK99gBGCdTiWT2S1CxmmtDhCggd4pU3AmIAuMKkiB1aU+LoDmE/yg7Rn0AS+W5raMR1dAvf+IWerbCtrlY3ir+uNNf76+fZ5bdH0IZgZahK+9xt4KVODma/ZPRCwZTCecuYwbZZtTzD3LTqx1GOzsQu6nOMxnlOdfAxra40LP+/6uW2J/GU3tC+EtoYOqtkGwat//vr7NUh+MwwXWEk/TS8CfCqnQk8QhK6AZCbHTTuj7GTJXTKPkmrLYRD4ieFpRo273tBqpFMFNEkiCMtOEy9GdI2WZG88LJTv0J5VeknAIj4l4mbeKFmBNRUELKfaKDMhU6MWa0rAPRegcQEKH1GxoNjWoveJEWkiLGMSkqChZvLy0pBxSaEJcmxYLM/hpFaxHs89ExCvcwqrCA7jnAutqTYilfyaTCMa6eYUkOhIhCd57xnni8UiF3E6N25SNLG++DC4vPp9eNXlGOoG0aL2mgd8djamtDldbEGpXye9k9P8bf6GY9ndCF0LT7ItsNU4vvkOtdu6gP7jF2Kj4EC+WlglyDLWDSGrxn3vsse36ZFE/huvkcaBGeSBBzcPDuY0+TBZ1pStnLKsViPh8ZNT6zUP0/PSxVuCSBIuKivdGRvHYuOesbFll6n27i1j5eXkQzR87OHJVpuC+LTb0Fr+7N5ety+cm49DdoxR896dx3s3PrVi3s7uM4EUje/sPHcWPbf5YPCbKb1soTi03wSW/zL0oyHvWFjkgu+3y9PMiwFbw0qruaf86vsXmt9Slg==
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: eJzlVs1uGzcQfhWCJxuQV4qtXoQgqBPZhdqgNSKnORgGTO3O7jKmSIbkSlaFvfVJ+mh9ks6Qq1/b7amn+CDvLjnDb74ZfjNrXoDPnbRBGs1HfAwKAngmmHWwkKbxasUaq4wooGA342tWSgWs8fgmNfvNgp6Mh7/fsOCE9iInN6wQQTAvKy11lfEeNxacoJVJgUfkRpeySgeNZSWDUF+EwrforLhG/2hjhRNz3OE8H92tucYXtKXD0UmPSwJrRajx2cG3RjpA38E10OM+r2Eu+GjNw8qSlQ8OkeDO0ri5CPilaWTB295R8JMxMyULNaQgg2FFRMnbezrFW6M9eHJ8PhjSv0NzPKAG5Ikgr1v0Phy8oV0YcAAd6FFYq2Qeueh/9WS13oO7C+SOg3PGfTAFcRGfx3tnIZwuNDP7CnkgvhyxHGTCt7PesSARRQWO/D2JuUWWR8PBoH3B/QvMbU34e0GZt01g2xTxlv6O2fysRRNq4+QfULxAzfA7puYTeNO4HJg2gZWm0c8J+mEw+I4JmuB5TgvFPLgFOBaPOeIIjTzkjZNhFSXi0spfgB7v296avwfhwF1iBcYvFLWoSEv42OTNHDll06RQxAhCqQ2JU3fhe0lbRry/uOgnwerDE2bCE/tF5+Gs07g+yUV/ncSp5YSLUCflOtbXuemCwn2NU/itDsH6Ub9f4NqZsDKTFYppyKThFMmhgxtniibJ7Ctu/svDFIlA0K+Z+7R8DOR+x/aUii7VyobzbdJF+tAJdEoXvnXyfdkJQixifpz0y5sJe4QVI9lAdrtaz9gtCvJCqAY26vxw4OeBpWPYvPGBzYA6VymfsEEtZahxc4TEHtgJ3jaIDrBZSRU5sCKH0x6DrMqO3I5YZ/h2hXeV6DhDcO8eMuob+9W15rP4dr1pLj9/uX0eW56D99hSHkFj8Xu/gZc8dZippR6AYFsG400nDtNhfHuLKW+cLoPUpdlIBjbieJXnGCddxcZa48KPu3xuUyJ/2n06LIT9GjqKZmvETv7+869TJmlgmC6hkL5O3R+e8lroCpjQBcMyk2WXzlh2MqcsmYXE2DI2CTRPeFxR5Zk3uBvwXjFcxCIIq15nL2bYk3OUOPoslO/hmUWaH9gyDhDxMG+ULJg1BQuQ19ooU6GwYYo1OqCcC6ZhyRQsQFFBkbRF/RMzrImwik6wBA0mk7bnBsVLCo2QY8JieA6qRsV4POVMsLJRiiq3QDiEcy60xtiQVNRslI0opptbgEWHRXieDZ5xvlwuMxGXM+Oqfmfr+x8nH65+nV6dkQ1mA2lRB8ljdHc2srS5XSRBKV/ng/NhdpG9IVtrfEB0e3jSKLab8so0gRWHqr7tRP/PjNhVc0CV7VslUD7ajpx1p8V3fHGBG5Max7bS6TFhPVJkmvVSFKNuZET9qjFycrNez4SHz061LX3+1oCLbQMZEy6WWRJu6ekZu0KJ1Qb/QsjJp675nrJXR8hXItzIpibNjCKXBslHUtXNuNtiR9toKSFLiyQpNuyZPRsQ2v3ONr76eHV7hdtFp1o7xX6Mit090AEvojoW74SCfqnHvGjylsoSNfTddntaedVgK3dpN3F0j53+H8EgYsw=
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: eJzlVs1uGzcQfhViTwkgrxTbvRhBUCeyA7WGK8BJcwgMmNod7TLmkgzJ1U8F3fokfbQ+SWfIlbS7luui6K0Xe0VyZr75+2Y2SQ4us8J4oVVykdwI5x3jUrLaSM1zyNl0fM3mQgIeL7iQfCaBzbVlvxhQk/H5r1PmLVeOZ6SC5dxz5kShhCrSZJBoA5bTzSRH9ZlWc1GQkbEohOfyC5oCH1Tl12gEJSw4o5UDl1xsktPRiP49Bcn0/AAxwENRVO9BeZLgxkiRBcvDb47ENonLSqg4ffm1AVSkZ98g8yhoLOH0Iholda1X3Fq+xkfCQ+VelhZ5643zFgOBbzBiFUdkSV3jg+0gGLnlFTx93FxerTxYxeWNUI9/r9EKkskscA/5pW89FhiPAiy+7kbwsxIr5kUFzvPKkHRt8n8tvaWkfa+FBXT9KwWg5d4RZ9pY25bvSZPhhVA8Wnop1FltLeZ7ygs4AhuVeY01NunlrX9P4s/cS1GJYxHBq5K7qYWF0HVbdqa1BK6aB7ew8scuewFru9HB3AG4Q9M1fbCD0duS5hKwJyyBol/nozchUv+0M9q4wFptP+icUIXvcasM7gcvJOcgfayiYIWlQ212Phptj6g/UvB7keQ9z5lQpvbMcItF5ikl0ft+pfLal9qK34CKshuaHyK3/E9DM1GxI5kDuwDLgplejFDIAVan8Gt0epNcGvEz0Of9drBJ3gO3YC8xwOGEvOaFo+iMdVZXGFN2FwcBRQShlJpmQAEhIJzEkuHibBiHwhBrGJSj0OeN+EkzR4Y7fo9QXcDS9WYMlW48IUqxEs9K7427GA5zvDvhRqSiwEHlU6ETgt9VMLU6r+MIe0bNSxruPDFX8Zy4i9d9IPeHEN9RpcUC2QX6MIPiAQ4hMhVzhL9UGCDJZVPkkTb7mb6cTtgjrBm1Aka1KfCUfSqBLbisgWYpXrGHjp4HFs2wqsZxOwNmLMzFCsftUvgSHwdI7IG9UtpDUICLgJAhBoZn8HrAIC3SntoL1gi+XevaUjhOENy7h5Q4s11Sm2QWfl3v5txPXz499S3LwDnm9SMorHjndvCipgYzdgTrgGD7CIb2DuQcBJJ961LeAlMLNdc7nsAlJ/RvhX5S/9XGaOt/PORznxLx8XDULYR2DfW82QuxV3/+/sdrJnDnYndLyIUr42YFq6zkqgDGVc6wzMS8SWcoO5FRlvRCoG8pm3hW4xqFN3J+4jS+BuwnhpdYBH49aOTDQocDORxz6QZoM4/bGVuG9SwYc1qKnBmdMw9ZqbTUBbIZplihAso5ZwqWTMICJBUU8VkgPT7DmvDroARLUGMy6XmmkbEEVwg5JCy4Z6GoZfDHUc44m9dSUuXmCIdwVlwp9C0MwwzpIjDorguw6LAIT9PRk5gvl8uUh+tU22LYyLrhzeTD1e3d1QnJ0DogvOwkj1Hv7Oho111EQTFfp6PT8/QsfUOyRjuP6Fp4wpr6ZEfNu0y+nz7//erdFLJHYh0ayUXYSkJcNg39fk0WZ3FtRgIOY6ShYMLZI+FmkXPE5SX6StKbzYw7+GzldkvH32uwYTpgjLgNhRVnxY6wiLcfiddC3xqaA4GAAsH1Ru+2PTM+XlHr84YXDpz4GDix+SDtuyu1bunu02OEQH+JxY+KvKXEI0u92z+PN88K7AklvqZg00L2FxxFpzA=
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: eJzlVs1uGzcQfhWCJxuQV4rtXoQgqBPZgdqiNeKkORgGTO3O7jKmSIbkSlYE3fokfbQ+SWfIXf2s7TaXnuqDvMvlDL/5ZuYbrnkBPnfSBmk0H/OJWWplROGZYNbBQprGqxVrLC1Cwa4nV6yUCljj8U1q9psFPZ2c/37NghPai5wcsUIEwbystNRVxgfcWHCCvkwLPCQ3upTVBxDFRFYyCPVZKAUhuiqu0DtaWOHEHAI4z8e3a67xBS3paHQx4JLAWhFqfHbwtZEO0HNwDQy4z2uYCz5e87CyZOWDQxy4szRuLgKuNI0s+GbQC346YaZkoYZdvDHWYFjR8sI3d3Sgt0Z78HTG6WhE/w49bWnCUAPogGd3T7hXWKtkHvkY2qKkpe/APJNauBXf4N+An49e0eYXnH7xhGLf646jWw7OGffOFERzfJ7sYcfwWgRm9gVyQm4dpS/IFO/OegdWIooKHPl7FHOLCRyfj0abZ9w/E+DWhL8VVFK2CWyb/Rjuk0R90qIJtXHyG1Ax1FhJsVDWiZrzpwmhqmLaBFaaRsfU/5Dy9j9lcIrnOS0U8+AW4Fg8pkclGnnIGyfDKvbghZU/Az3ebQZr/haEA3eBeYgrFLWoqFlRQ/JmjpyymyQAxAhCqQ31fgWREOrcMR8uzoZJDIbwiGnwRH3Rmp+0+jGkRhquU+tvOIEiyEkXeuoFc9NGhPsap3CtDsH68XBY4LcTYWUmKxSqkEnDKYxe3zpTNEnCXnDzbx5ukAUE/ZK5T5/7QO52VN9QxaVC6QjfZlykhVb+Uq7wrRXHi7YnYgXzfsYvrqfsAVaMOgfZbQs9Yx9R7hZCNdBp3/2Bn3uWjmHzxgc2A5oKpXxEaVzKUOPmCIndsyPsLogOcBBIFTmwIofjAYOsynpux6w1fL0yjSM6ThDcm/uMWnO/tNZ8Ft+uOhn86fPHp7HlOXiPOv0AGivf+w5e8tRipnF1AIJtGYxtThymw/i2hSlvnDpB6tJ0eoFDLvbxHOOkPmysNS78uMvnNiXy/W7psBD2a6gXzdaIHf31x5/HTNIwvllCIX2dJis85rXQFTChC4ZlJss2nbHsZE5ZMguJsWVsGmhWe/yiyhNvcDdgXzH8iEUQVoPWXsxoWqG+0bJQfoBnFmk6s2Ucz/Ewb5QsmDUFC5DX2ihToaphijU6oJwLpmHJFCxAUUGRrkXxEzOsibCKTrAEDSaTtucGlUsKjZBjwmJ4DqpGxXg85UywslGKKrdAOIRzLrTG2JBUFGyUjaikXRdg0WERnmajJ5wvl8tMxM+ZcdWwtfXDX6bvLn+9uTwhG8wG0qIOkseodzpZ6rqLJCjl63R0ep6dZa/I1hofEN0enu5GdXin6Jfw3iD6r+5gbUUHVNqhVQIlZNMStG71+JYvztJNBRU5zpVWkwltT5XpZpLiGLeXMtSwGqMnN+v1THj45NRmQ8tfG3BxbiBrwsVSS+ItPT3jWCix4uAfKDn60E7fY/Y9l7QXgu1UVJOERs3DN3x8IJHt7pYbnG6dtBLI9JEUxoY9s/4dbrM/5N5fkkaJVsB24v0Qxbt9IOfPIurreEJAvzRunjV5TRWKcvpmuz19edFgq3xpN/FzhxP/bxk6LmA=
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: eJztWd1y27oRfhUMr5IZWf5JeqM5c6aO7Z46TWMnciYXScaESEjCMUWwAGhZ9fiuT9JH65P02wUokpLlOOdMr04nMw5JAIvF7rff7kL3Sa5cZnXltSmTUXJilfTKCVmKi0qV56fixJSlyrzICq1KPxRXcxWfhSrlpMDkSjq3NDbHsxOFmelSLLWfi7NPp+fisywK5cVkJaz6R62c1+VM3CqrpzqTtKsTU2sWQpe5vtV5LQs3FKe1pWlxn4yUwsyBkKKyyuEbv4tcTXWp+dFVKoNIaLOc62xOa3LM0xAnvGn2FntCVpWSLF3imOLDR5GZXAljIU1VotDljYA8j2PKGn8hI+iJY87UUBzvVGGiClPOeDvpxcJgO1OqteF+0bdKqDuZ+WLFA2YqUs1K+tXfpc/mUOrYe6snNVyQkkppButNZHbz6eN5Goy6/jRWOKNPg0dk6ZbKirkpcse6z1SpLFyZYwErcJ6nmLV+bVYngyTa5o3JV8noPslM6TGBHmGrIp5+/1dHALlPXDZXC0lPflUpQMZMfgU+IKePpP/ZcY/XzuQJE+PnA1rMb2XcCSZYDIR2mDutncqHX0toWFlTKeuBEtK/68fTtRvP887ZnCekbJ2NLI7QCPvsxANwgK3FFLr5OVRpgPCbEXT+9H5zBrS3wAKszoPS44NaVAWQMODFzZtY1JA+USLlgL222t1cd9Zew5LX3h0eBcc8PgneeG86oSYWcoVwWqjgDO2dMMtyW6UXV+PDoxECarWg+F4GipAeOPAx0p2Z+qW0StAXRdMG4sPZ+PhkIMYnx909yVXu5Ui4GmEvtwxSAh+IjKq2lYE3/BzUxqchSDwMklIu1PM8TjMbnweX0Hoooi0CAJB1HTnSWrmCGA3l3bb8h8c2aEQJkhVxo3rEmzZTrkGQKSmD0xBNGbgmAKIJDvbvguJMdGKiicghaQCzm6XKL6yGOX6v8ks1AVJYEm22MrUVHf7gDXeH/2N8IvOc/SiLy17cfkeZY5y6IhU6GAkbIz1YDq6skHoB+Pm5oxDNKRUQ8XNqkgXsx9Zv1A1mxOBQnEnY80atWokUc+1OI3ZZepv5xjvj0723n686U0IcprnJ6CDNtAXee5OwvxRpmMI68UTx+dVJZ1pARRjWgfhz4/ecqmQgfzojnTgAiU5Nkakpv0m/QxBDhUZ5/kRRQAfZqasnacxkBCqstSs2lZK9nCt0yKCnJx/eCeARs54my7A/GZZyFE8kzRnE6k7jb6NzKxLeuJNgMzUS6f3XpLblSNW5HlU6Hx1+TUbia4JMpYuvyUNKbo5n4G9pPF3U6hJs3tF+h/NPDfKLF9A/B7fBrDPF3NJPVJS7QrpRQT3CbF85oJS1SB6A3s665/EQJlJ6CHWODE6JrlvqoiBSh8ysLhgBZE8kTihAL1mGOo1gHjFBvuj5ZCg+OSonxF+vri7H8HBeGd3QT/MGgZkCCNyWSx35SYrLi/HVmolIA3ZkLFLYXETrtRNHBwc8LsXb8cV7EWI/ODrUMhFyT5v+ibIisny/inienR3PDQRBGTnLqL5lDPV8LT7ioGDlHC5R5UYRg6h0yjP7ddLgKbLgcRb22lZlIe/eqXLm58no8PXBY6p5dRetFMYm0RWh+I6+heK2CcROKT4IARuwKdJ3ZibCGqZsU4IIlZhIlMGElrr0Wyf8HUUIFQwAQkg8z5NWmi1xAY3d9oKcU6HcaMom2E1kc5Bg5sH5G+GYfP/MHJk2njoZfdldLMYK4tvDQ1jiKkRBSFRHB4f030aH1elpFC3/zfV2v5ptqvwfrV6jIp2Kptsg/FCk7JAYLDNXMocrSOAJkoXaQ2PprSkePeN6r9Znpdlz3li1nfDP0Tlm3LVyRHiupIIbhJubusiZO5gWsVE+TFih1wcHP9TuIOFdTAGFbUeAelhFlCnoYBF0ylpjtyx1Rl8bEoy2ik12s5J44n4t7/jyPIp6+NbLJuHjKNElaF/n15FpyV40cr1ZEMU+mmOzgHfyFayB0Gs81ZSaVVAjhz6deGzhngRX9sW/kXlD9SEuq8YM4agukjSrFnvQLTXTlgsm6EOJNslnfDxODYNIrrviMB2IlAKx30fGppHELbRzwFSUQ10jzSyf05mGtrnL6tSYzJAAy9B5fo/GWqO3/V2vrm/adzgo2ObE5Kprq9NHTXXZvXh5x9yPxKBKR5tGE4ZLmpwa/TYEA/4Pfwj/XTZc69hArqNfAqw+TVXt6jbiUVWombLdkEeAPjwi/kmWIDDqsqpR1ID8Fwrs3xBQH7Wfytg2/ZNJuG+aP/1RqOFqM0/HZ7446ab8pxL0ZnZ+lCVie6HzIOLpbmDwnMsimvJoSZU2lz4xFbABQkOFk8GlFi1lsJ4wWVZbnDJcK2EVRtpLNEStI2uUjzFWiFxyxCM89/34RRWbyZIi1HLz1OFfuxmssCZSLFp+v2KUHVf6b4oevxEm3ijQkT2uqV7EFwo/OXMUphtXuKH0oPhEYMwNIjmpDGODmi287d++2gfop3q2v+aRfaPzbD/mctLD3rJaXzYLm1O1MCIMY15tkdmTufeVG+3v5xjbk5Ue6hk85ofaMJr7AoD0vA4w2iHmexLGODg1NzuWuzC8qci31rpjCulAUo2N20uR8GGA0CKZ7J6m+kNARjZhKG/FN6GEm9vejfJW041yvCcnFWGb9WUd4mWq7ygoGWpBR5GKF8CRCvd7Fn0l26CSmXo5EGqIzrUvdiTiwp+o/CVz7EG5n1PuUrpouk8m/PYXY9EF4xxvP19tny32ReaGeAIZqVEvSIo6UxD1lBBrCzKPkg3DZsk6fZDfuBAnxv3Y3lKftXS3+w63zQ7RQ+v3/o3dl2bg2/aFWHfs6burXf39RnvfKrHZkLYjO9rEZzUtBM6paXIXhHBKYFWwQ11Vxvo/t9Bf20b/0n7qx0w33DYcv14kXvznX/9+SUlDijHsp908ZBN1hx6snCkmwu5vPhyhOuswnjj34Y7GqWK65wxmKz0r19cwg7ieipnujzv0m1AOd3kQd3OPjM2cocKxMsgBKpuXhhpjhclcDfGPP6JUS1GoW1VQ7HFaoBpFThA+PlxDIVoNcM+/RBkgTssyi1fbfDyrZnTJ0l57TOuioCDPoQ7puQDBBzZH8QA6Zcg2hFFRMyKOhgdbNl8ul0PJw0NjZ/txrdt/d35y9n58tkdrHtraovUD0UxusnrRhAREE1sHfx0dHL0evhoe0lrifWjX0Sf88icuzk9PmkSx4fBOQfT/3wn/gL8TRlamu6f9qpCaL9YYufexgPiS3L4KNxooIbguj0UEnqmMSJrLBSLUOZUeWHJ/P5FOfbLFwwN95qtdKmQAXdifkBMKnSblUuVxQ5k5OQlw3LsixWg6Eikn6o1anQqFsOKYr4menNutjugaE5Mn8ZfRBbcsiZVLyiL4O0q+4h8djkOEMwF/v08K8F4NIGBOkEt5TMas2lYUN1xRxIdOAyHLVUfLzeIiHIb+ck/w2JKfiAuQ439eTw8jOxes03GYTd6lO63/ArBwbr8=
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: eJzlV81u20YQfpXFnhJAphw7vQhBUMdyC7VBY9QOeggMc0WOyK2pXXZ3KUUVeOuT9NH6JJ3Z5Z8oOUUOBQr0YpO7M8OZb2a+Ge15CjYxsnRSKz7jt2DWQoFyxY4ZWOsNWCYU+1CCWszZtVYKEseSQqIIXqRMOhSwVidSOEhZotVKZpURZC9i97nE64ReWCKU0o4tgVUq1QoidrezDtZn+EGRka63ageCKRSAViM+4aUwYo0vxvLZp/3I6/scGLqnV8zhU7CDOpLuSuFyfFaojW/hbpHiiYHfKmkg5TNnKphwm+SwFny2525Xkqx1RqqM1/UDCdtSKwuW7i/OX9O/Qx+uAyaNy2gfoXDkx2xfT3gOIvW+72t8e31+TgZ6CS7KspCJR236qyWD+4FDvaufOBijzbVOAT/hn+cDN9DTxnm9/BUzRcAZXYJxMrjea/dxSvQiA0P2Pot1WeAZOlifMH+EzUCFvxNYDaqsHOtyhdjVFO8hUiRIEYF1VCHAbrGAttqkBVjL3utMKgafERlLZYMFRNUASiyLUApjLF/9j7H8qETlcm3k777mxtBcfhU043CddN6bW6M3Eu0yHwQf+3BDp0gGdosiTQ82hNFqRqfBOwXCcWd7UWSWFCZshU8NTCyWaiMKmT42xRRPWIyl8rjSSDAxQ8nYgtmAefQWYt6m4TH9ch6OXTAgEC3/ddd6xH06upx1IXGUWso0BcVPfo8H2mOHtHfMevxEuu87eqO+sIf8SXR8bGVcFN98JfcgU39Yec79N8ujnuw7e1e3ixbhh5MAD7P6DMYLjM4oUbAg22fsCNKTkoGXyjYwUVjdRGDZVrocgyD8nXAVHuSgkKPaxOTC+hgzucHzxTzYauKny7gjjtjnLB5zQxxMyq4osPyS3BstBw01zCuGZSGpjHQ7n6urUv4I9PhAyL4DYcBcIVP4E2I2kdEg5aPBHoYYUR9yTq6RJHmoIz+BSZ1PN5fTMOWnHUlPtUyTaYh/um9nbM0nTapOzew5bhcN5ihXmQLPcudKO5tOU7w7E6WMZGaEcpHUvkBGq4rRaRVWi2fM/JOFO0QBO/45dRuux4489FDfUZcEPmsB79pEhINmCwm56veQq4a1fdcdtQx1wBPsGHE7Qtk0ZygkpLwK2j6KD+zELHyGrSvrOaA0sJKfkRp8zcbBRxazF1hU4A04I2ThMShFAi8nDKIsGpmdsUbxzU5XhuA4Q+fextS1B6W150v/9p3GJRKphf/wy/1xbElCY97pJyzxEid/616w1PiM048dOME6BD01EYbhY7wb05Q3Tp0g1Uq3HIfLp6eONcZJ1FGVpTbu2z6fXUrk9/3RYSEMa2gUTafEXvz1x58viZUFu9tCKm3OUuEETqskFyoD3+pYZnLVpNOXnUwGPc0WjlW4Y+JNsTqzuHwbkBkSQUpF4HaTRp82IZbgDkPHyE0T/GYqM+mQxbaiwH71H7MahyMrdcocJLnSBW5WgMJ+laKcC6ZgywrYQEEFRbuLn9FiiTXhdt4IlqDGZJJ4opGIpVDosk+YD89AVhU+Hks5E2xVFQVVborukJ84nVTgKxwySBeeydsuwKLDIryIzo8w3263kfDXkTbZtNG10/eL65uf7m7OSKfuZ1CfB+qdVCfVGsFpu4soKOTr4vzidXQZvSLdUluH3g38mXuuYx8W8+uWCkcJHwzO/+5vpaYfHPLztCwEElDdwLtvWPwT31yGnyjogd88GybHZ+Jyumvjn3W/mZD5csSM1Pf7pbDw0RR1Tce4fxk/bRBrYXyBBsqX1q/tfLbCOoUvgPni52Yvf8me+TV3MqqWbBUxradGfMPHJ+Li/tde/dD9BvN+hWuiotINFI82oXo4Cec372/ub1BcNGzXM/2TZ/rmYbArHfo1Jv3gBf31688plTdUzsi9bzvxcPOsQkeTQZpQesD14G9FhY+N
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: eJy9WNtuGzcQ/RWCTzYgS66TvghB0cR2A6VpHMQO8mAYErVL7TJekVuSa1kV9NYv6af1S3qGe9FKWrtx69Yv3gt5OHNm5sysVjyWLrIq98poPuQXudSjM/bRmjsVS8sio2cqKayg90zqODdKe+ZT4ZmVvrDa4Uay3X1z6UUsvGDCMcHeXV58YLGJirnUnvd4LqzACmkdH16vdky4AhygzCwAG5sIrVw4HzsVrciFT3GtgYG79opRjOdW/looK2M+9LaQPe6iVM4FH664X+a0w3mrdMLX6xta7HKjnXT0/uT4mP51UnJqtJaR32YEp+Hek1fYJ/I8U1F4MfjqaPNq/3Az/QoYIsGaXFqvyqOVc4W0+0b2Otj5/Ol9Tc8O73zd46LwqbHqt2DHuA7Zk5G3YJrI0wHe3Mp/ARy2bwEWTmLjzPxzzBphC/br4taNC6uejBbS9Yucsp/lkl3KAOYiRMuNXZHnxnpKrgZUWCuWlJtezl1HmnWdVsKxBo5Nlw/Fs87QMcE+nwU1LAuw32RJYoX2z2xGwHyCDa4I9fPMVlSoT7BDxeOyDpxKNHDHIkvGdyIrntOqEpoBGpXo03nbtJmxwTbYFQyBnOGvx1Mp4iCsK7p7WSraN4vURjuvubTW2FMTS5gdrs9aFkI6Hxe0ze6NsyhMmYA/4N2LeZ7hGQxcd8B3lGyzhb8RMVM6LzxrGknt/TaJtJA8ks732dVON2HKMW08iCx03Of7zL18EnO7bHjlg7FNSww+7knPOT1lQrsFlnSLer+b22+TtbAUTSuWvZAyFYtsojSyFVlc8TPpsQnYGAc2JiCKTaCpd9KOA8KE11Eax4+HqUtpBNhqErY0PkSrCWnjEm9s4J3n8Q91xHhHvJuXZbQ/CucWxsaZdI69N4lC27lHNB1FP8VkoiUcZFMZ+pGYZq2yamfKfnJ8/8SyMlpezMKs81+mybq3avBefxzVTN90Et2O7gNcj+Cd1SJj5dpN5PaI71xZBqGymeieNJowweO4um+V/YQtUsRCYcoSmmoTqROlwdm8VQztWMAUqox6+hvyRPqL0dnpzpTmRUKz5t58e/CLQFYgiOhChyRqUJPUVDhhUsWoOeSDuxcDck1FctCk0MCoOBqstufP9aC/kFl2dKvNAitwnIqPdmfGkqWu4fdMzk1FItYVNsOz1PvcDQeDGO+ORK76KjTNvjIh4tsA8CwuoqBvD8D8HcIluKKu88B2V77eNeSGvIowbfnlJaV9KVSvc4UZqt0GywfVIF8GcjPKv27PnHs1QCl9i4mMJlNUXVVtZZaFzlsXxmQLZ8LKY9i8cB7FjlSSM3WPWl+gp2JxMIlN2AEyTpYjqhUqCxzkIpKHPSb7SX8Hdsiqja+WprBExxGM+2FCZcjfSGGlpfXk+zTc/WTsXEAr+LsvV/u+RRGJVDkb59Ct2rwSqbIZXY9tGcEaBoPWEIflYbxpzxQ3TmVC83EtWiIKogV1UhTbaqr4cRPPJiTq7ebRdiK0c2jHm2YTO/jz9z8OqdMKdrmQsXIpC5+F8j5KhU5k0AGkmZpV4WRVmW0Kno08zfeYfWQ2O3IGqyUGI4aXSAK/7FX7Sb9ZhNmFHovM9XBmrBLlIUsLkWXSh8OcQddjuYlR9VGqTYa+ILE4NIAwbaEtLFiG1pBRQtHMEpqvmCIn/DKAIAUNgknLIwNlVULD5BCw4J6VSZEFfxzFTLBZkWWUuTHMITvn0LdSzNA1ICdBmusqQNIhCU/6x3ucLxaLvgiv+5CdQbXXDd6PTs8/XJ4f0Z71pqls4kC1U3+A19VFElTG6+T45GX/Rf872psb52Fdy54zha8VLF6y8/rraifgrU74P/2CUCW3hxgP8gwaHr4jiatVpdnX/O5FJbVgKcyPlW7jmpQb/4Z7vx20xJuHzrIv31C6FBzRCavVVDj52WbrNT3GIGUhdte4vBM2JGQp8TiBhgs+nCEv5SPkHXyq5u9D9ujPIJ3u1xKrSV+DIOIOl7ekwLs/k6xvmm+FYGO5iGQo963te2PNut0j355fQVr+AnMqczw=
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: eJztWdtuG7kZfhVigC4SQJa8TvZGaNo6tnfrNo3d2EFaBIZEzVAaxqPhLMmxohq665P00fok/X6Sc5SsxN50L4peJJJmePj+0/cffB8lwsRaFlaqPBpHF4XIz0/ZicpzEVvGS5sqLQ2n10zkSaFkbplNuWUyl1ZyKwx+CrdS5FbGfuk8U6sheydsqXPDeM7+eP2XN6zgC8FWqdACuxN5J5OSZ4bFeN/aL1hpZL6gY6VmZ+9Pz9kHnmWC7tWqXKTsr+9YrBLBlGaJEAXLZH7L7oSW83D/kB3PrdAOWXMTK7QwuMQjjrVI6EYgGLgHDh0eSg3R/ZqZVitD5yg2rd5MSi2nbCVtyqaEYgrxEjY1FsinQ/YBYvTvTRS0lCvoMzcrHEebZc6+/4EtZV5ChTsB+CuE1kq/gtaF5jHJNtHi5xJLElx2jV21VXgciwL7fjq7dpAuL66uh9EgKrjmS4H9Jhp/vO8ZnE6AwdXcIVB6wfNgbuyUtKLgNsX3HGfgV3vFeYLnFZpobHUpBpGJU7Hk0fg+suuCdhirYc1osxn0736fy59LKMqZYS6hmADDAP5Mfe7AGe7GE5Ze6MXj0bjjgECvW+fFCuu2D9rWmltZISbdG8NolzA2evjiQSTycglDRNidyyS6obPnvMwsadc/exAd/LdQuRETd+jXoKSFBLLaiYAxbsfXQCT37gJ0Tx6EF2cSppzIXZbY53Z+3x5IexTSBOVXXfr+3TlF8yqVcerurhWzklnGZrAroAzZuWXL0uA/brFQ5bWlqxvpJNMVgInPCNFsPXyKJI4/vijCcc5UwSlq7nhWElOKhORZcjAA/jF3DMSwKxF4KPikowSHFVw64/HtU0DmKo+7IOegz22UzB/UA8mNUTGlDMYrjRlEDeULx3VIA/AJq25FPvBwIRiSzIK2aFFkfM24tcBu9oK/GdSBYuj90eEhfXQx1rmJrcTMUa+nU0fCJgXvO21VqabSnks1Lv9RrPo1rRQV+H9aR8KUScPK/DZXKwiFhLVy77vJpM4P3tt4x8m6PtbKFA1IlyMcxFw1ey2/xbHQWizII2OFHIIoI4WJz3aU2mVGPx6mge3ocVk8HFThIixQ+mYQpYInLsvcR387+JGSzsGF22269yBMlkVGV52evf17tOnf9DpTMLEXcq7VEu5MzqSR6VA6JMisHsicrhgwGT7FciYSp2M1+0QKEJlYUrofYOuC6yQjiq5SjCQ3tFYscSsVGwpWYEYNvSgvDo+2Xea6FU2SyH5Onu1upCPbBQjVNGRQhKO2wbG0QjmAJPeoEoOWuCBkTRoPRcF0EL5MWjC71UjH7F0LvVEe6X4XaEyVWluY8Wjk3XAYXgxjtRxVjPL7qlZB2MtkElT13RbGV5e1KL85OiSaxcdM4L/SVQTfOfSv+PxQzj+ZLLn9tO0j1z0qbrTlg6HRVrDoS08CrSjgRZEFc40+mb4mGor7GLkjTyj1Dfz30xYWsE3Qmnc7qrg0yEFb6emn2d0omOq5hdBtDQPgZsfxe43ymlM0FKVt5CVpN9shhYXBHj1v9CWpqRmYAmLNZipZe6pqp5BUZYkhNw1VyJLKX39eqGxTXnnnSVMa92WaNie3KzyKKYqZuSrzhFy38VZvwJePMmDfKFZap7PLSnIHa4vmzgKXOnECWYSuqNo53G3ir6NQ756UUwaQVLNgTDbthQ1FN7QxcdqYEsdMQRPgmIkP/qhylkmy31t2xQ031KMF3vLgndPUnlWLFNUYop33RW8ri0U73K5+6Z3kEhXASgUifqMWIHJkIqRRsj65Ti4gIOheULPJZxnIvkL5UE/QdZIfHhnlKOwu5q4t+m+6C5VT1XnHl+eVxm92Krxt5Qd0fk7dYI7G0q9tLLhlgJ0rnxyx0lZ5DS4U6ueiFRRtWwAKRUjVKI6jhbAX56cnx2j0r7wtSct8QV1p1FMZe3a1w9zPiWtBcqkK57nmFt3gOBrdvRiRiDIWo9qlRkom8ei+27JuRvftnnEzoskDlZNOQbta5FOxVEF/WFfqrJUNE7w74IUcyoXmSItSRdt9LqRKSte7P3TMl064gp6oSnlgu/Gv+0BuSKoYtYRdX5HHe646LuSfxbrFFNw/CO21t2FT8h/7EdA/qplAr9KHN9+KdW/84x3MF/8hJqadc6bMX+N7rBl5kZjLzwh3P/TwGNmUPYOzCXeA1VxmTgcFCtrnKPeGi2Hv2DELG3+7VqUmdRwA3O+mFIHRa8G10LSeZJ+5Xz8qjZIbcvzpw/W2bL6nd/0I8qsxFTx/UsBM1WgHBKs16GiGdOgvi+pCgexGTRY0PlcVX6F1dDSAVo5sa8qiUNr+obFnbRL5U/Oo6whtH+pJU29iz/79z389p2TL2dUKJZRJWcItBxXHKc8XvtfpFLMhsppYp/YYta/Bm2x+YBRWC7nIwyjHrgdhP1F4d9DGWSIX0oKRVn6mR5cZhcTHCoUWS8RprjKkBhqKuRxANufIDCuWITtk5FBuGubYZQafQLlCh8AFFYxJy1GUgvQ5elVvMCceeoAyc/IYshln8zLLyHMTwCGcS1Cb5zEkDDCIY+UqCuB0cMKj4eGWzler1ZC710MwzSjsNaM35ydnb6/ODmjPpsknjR0odhIVl9SjVNFFFOTtdXR49HL4Yvg97S2UsUDXxtMZzJ6FEWDfhVuJ8P+T3f/ByW6gE9fOo88Hf2+Cd96HxPgxunsRkpt0k5s6OeI7pUd8jLdmuuPeVNWlSGSTFH5IZ97fz7gR73W22dBjPyRyiROnUNW2ey7Udsdn74Ksz9mXh6k75bylJFbPa12ywW+fPJ8KY8+0dA+G/lT222DZMR7dg6E9ev029/9ak9K9iu1Md3+5XN92fLrPLcM094mQf5UB6h741Zy3gX9DP7RL6L8s0h/8Y9NOOFWJmq/baCqYPeJ6sls8+g9RT8DaodTNTT2Mc9r0S44dzbc2N3PaTbvzQRpA9fgfsoJ5Mg==
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: eJztWd1uG7kVfhVigC4SQB55neyNsWnr2N6td7OxGztIi8CwqBlKw3g0nCU5VlRDd32SPlqfpN8hOb+SlcSb7kXRi1jSDA/5nb/vHJ7cR6kwiZallaqIDqPzUhRnJ+xYFYVILOOVzZSWhtNrJoq0VLKwzGbcMllIK7kVBj+FWykKKxO/dJarZczeCFvpwjBesL9c/fKKlXwu2DITWkA6lXcyrXhuWIL3HXnBKiOLOW0rNTt9e3LG3vE8F3SuVtU8Y399wxKVCqY0S4UoWS6LW3YntJyF82N2NLNCO2TtSazUwuAQjzjRIqUTgWDkHjh0eCg1VPdrplotDe2j2KR+c1NpOWFLaTM2IRQTqJeyibFAPonZO6gxPDdVsFKhYM/CLLEdCcuCffsdW8iiggm3AvBHCK2VfgGrC80T0u1Gi18rLElx2BWkGq/wJBEl5H48vXKQLs4vr+JoFJVc84WAvIkO398PHE47wOFq5hAoPedFcDckJa0ouc3wvcAe+NVdcZbieY0mOrS6EqPIJJlY8OjwPrKrkiSM1fBmtF6P7v2Gv1ZCr9odTaKwbnOjTZxuZQ2VtDWGkZQwNnr44FEkimoB1SNIFzKNrmnvGa9yS/r4Zw+iQ8SUqjDixm36OShpIYGsJRGixkl8DkQKqD5A9+RBeEkuEcM3cpsndjnay+2AtMMgbRp81qFv35xR/iwzmWTu7MYwS5nnbAq/AkrMzixbVAZ/uMVCVTSerk+knUxfASY+IinyVfwYTVzGflKFo4KpkkOU3fG8Im4SKemz4Mg5/GNuG6hhlyJkfohJl4QOK9hrypPbx4AsVJH0Qc5AWJsomd9oAJIboxIiacZrixlkDTG0YxcQL2LCqltRjDxcKAZan5OIFmXOV4xbC+xmJ/jrUZMoht4f7O/TRx9jUw3YUkwd2XkCc7RnMjCts1ZN7rX1HLm7ikO56td0ikJg3EmTCRMmDauK20ItoRRKxNK979N3w8g+2ngvyPox1uHmFqRjZQexUK2s5bfYFlZLBEVkosDayDIymPhox5ld5PTjYRrYzB5XN8NGNS7CAqOvR1EmeOp4/T76294PRPN7507a9M9BmizKnI46OX3992g9POllruBir+RMqwXCmYJJo7agWKeoZR7IjI4YMRk+xWIqUmdjNf1ABhC5WFCBHUF0znWaE0UH1EZSGForFjiVyruCF5hRsVfl2f7BZshcdbJJEtnPKLLdibRlt+RTF0EORTpqGwJLKxRg1NsvKuq0xCUhawtnKMOTUfhy04HZr/89t/c99Ep5pLtDoHVVZm1pDsdjH4ZxeBEnajGuGeVPdXeAtJfpTTDVNxsYX1w0qvzhYJ9oFh9TgT9VISHzjUP/gs/25eyDydPbD5sxcjWg4tZaPhlaawWPPvck0MkCXpZ5cNf4gxlaoqW495Hb8phK38h/P+lgAdsEq/mwox5Hgxy0lZ5+WunWwNRBzYXuWhgA11u23+mUl5yyoaxsqy9pu95MKSwM/hhEo28CTcPAlBArNlXpylNVt4RkKk8NhWnoQhbUcPr9Qi+Z8To6j9tmdKjTpN2528BRTlHOzFRVpBS6bbR6Bz7/IgcOnWKldTa7qDV3sDZo7jRwqVMnkEW4h9SS8XYXfx6F+vCkmjKCppoFZ7LJIG0ou2GNG2eNCXHMBDQBjrnxyR/VwXKT7o6WbXnDDd2KAm958C5omshqVIoaDNHW86LXtceiLWHXvPRBcoEOYKkCEb9ScxA5KhHKKHmfQqcQUBB0L+h6x6c5yL5G2Y2UzeD47guzGw3d+cxdQP6bYUJtVL3f0cVZbenrrYbuevcBW5/RvavAFc6vbT23YfitKx+dqdLW9QyhE/rmspMMXV8ACmVGfSU7jObCnp+dHB9V7uJm+ZwuftHAVuzJL9S9wnm8sE+JU0FmmQry7toI8cNofPdsTCrJRIyb0BkrmSbj+/5lcD3m/kRvgW23zROxUMFAWFfpvFPmUrzb46WM5VwDUiyV82Z/A6BPK3cNfmibT+1wCXtQ+/GAuPGvh0CuSasETYJdXVJIexI6KuXPYtWhAO4fhJuzd1Lbyx/5aco/6uv1oIVHuN6K1WCS4iPId/Uh6Ce9fSbMH+MvT1MKEzGTH5HHfn7gMbIJe4JoEm4Dq7nMnQ1KdKpP0cfF83iw7SELgt+vVKXJHHsA98cJpVj0UnAttIsv6D51v35QGr009Pjp3dWmbv6y7i4aKJzG1PD8TgEztZk9EKyxoOMRsqE/LGo6APIb3Z5g8ZmqCQl3QpfnuKORb01VlkrbP7f+bFwif2wf9QOhG0MDbRoh9uTf//zXU6qinF0u0RuZjKXccnBskvFi7i8xvS41pFKbzHTvRVNr8Caf7RmF1ULOwQBuOGVXoyBP3NyfWXGWyrm0oJylH4/RYUahorFS4e4kkqxQOTif5kuO3MnnHJS/ZDloP6eAcoMlRx9TxAT6ENoEIajgTFqObhOsznEJ9Q5z6qG5r3KnjyGfcTar8pwiNwUcwrkAd3miQkUAZTjarbMAQYcgPIj3N2y+XC5j7l7HoJZxkDXjV2fHp68vT/dIZt0WjNYPlDupSiq6fNTZRRTk/XWwf/A8fhZ/S7KlMhbounh6M87TME0bhnCn0v1/SPo/OCQNdOLu6bjAg7/XITrvQyV8H909C8VNupFMUw3xneohPg43xqOuJKJ6ZIg72uP+fsqNeKvz9Zoe+2mPK5SQovZr+4CnG35P3gTdnrJPT0W36nVLRasZvLrigt++WD4Wxo6x5w4Mw/Hq18GyZc65A0N3hvp1zv+9Rp47Ddsb0/52vb7uHHRXWIax7CMh/y6T0B3w64FtC/+afmhXwH9bpj/4/zRb4dQtabHqoqlhDohqfd3MqhxGv+jIkWVHvB1jrrsXBpAperD/ANy895A=
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: eJy9WN1u2zYYfRWCVwng2Fna3RjDsDbJCndFU9QpehEENi3RNhuZVEkqjmf4bk+yR9uT7HzUj2VZyeouW25iUeTHw+/nfIda81i6yKrUK6N5n1+lUg8u2Adr7lUsLYuMnqpZZgW9Z1LHqVHaMz8XnlnpM6sdHiRrrltIL2LhBROOCfZ2ePWexSbKFlJ73uGpsAIzpHW8f7NuQLiGOZgy02DY2JnQyoX9sVLRjFT4OX5r2MBTfcYgxriVXzNlZcz73mayw100lwvB+2vuVymtcN4qPeObTae59yetvmaS4Qjaq6nCQQoYTuh4Yh524HTb8RRTr+zsQDS3NNmlRjvp6P3Z6Sn9aw3QudFaRn43PtgNz558jHUiTRMVhRe9L44Wr/c3N5MvMEMhsSaV1qt8a+VcJu0+yE5LrD59fFd6qZEFfNPhIvNzY9XvAceoTKCDLe+YqfKQNvDmTv4Lw2H5jsHMSSycmu+3WVrYMftleedGmVUHWwvF81lO2G9yxYYyGHMRouVGLktTYz0lV2VUWCtWlJleLlxLmrXtlptjlTk2WT0WzzJDR2T2+RCUZlkw+01IZlZo/8wwgs0DMLgs1M8zoyisHoBDxaO8DpyaadgdiWQ2uhdJ9pyoctMMplGJfr6oQ5saG7ABVwACOsNfh8+liAPNr+npZc5o30xSW+684dJaY89NLAE7/L6oIQR1Pk1o29Xbw6Iw5Qz+g70HsUgTjAHgpsV8S8lWS/hrETOl08yzqq2Vp991Ik2kE0nnu+y60duYckwbD0dmOqbO0vTcy4M81/SGVz6ArRp0OOMe9VzSKBPaLbetr5Fu3XbffhuthaloWrHshJQpvMjGSiNbkcWFf8YdNoY3RsEbYziKjcGp99KOgoUxL6M0ip8OUxvTCHirStgcfIhWFdLqSLzCwFv34+/LiPGWeFcv82h/EM4tjY0T6Rx7Z2YKbecB0XQU/Tl0kpY4IJvI0I/EJKmV1WPyYzdJfjywvIyWV9OgwP7LdCGVVdp79WFQevy21eH1KD/i8wFOZ7VIWD53G8G9ALTOzINRYCa3jytuGGM4Lp5r5T9myzlioqC2hKYaRQpF83DYtFYU9VgAClVIqUn7fCb91eDi/Lwu14Z5UMndYkZKeE99Hw1b4n5MbAeamZvCcBDUUKB93rt/0aOzqkj2qtzqGRVHvfWuTN701nWduul1lzJJTu60WWIBYKj4pKktcy+2SfYLuTCFkzEvswnG5t6nrt/rxXh3IlLVVaG5dpXh+7obJ46zKPDgI2b+ycIQPqTu9Mhyl79uArmlU0VQZX41pLLICe1VqqC16u0yHyjkfh7oreB/VdemezVCKX8H5UYKlm4VeTXmWRg6dFk44x07Y5ZvwxaZ8yAFpJqcqgdwwhK9F5MDJDZmR8hImUtZK1QSfJCKSB53mOzOug2zfVYs/GllMkvuOAG4n8dUpvy1FFZamk9nn4SnX41dCHAJf/v5ev9sUURklmvoFPxWwsstFZjRHdkOCFZ5MHAR+TDfjFdtnOJGFzROOrokNREFUgN7KYptoT5+2cazCol6sx3aTYR6DjVOUy1iR3/98ecxdWTBhksZKzdn4TIrH6K50DMZeAJphitiHk5WVN2WENjA0z0AGkkm0xNnMFtCQBVXS7/qFOuJ51kEjUPDInEd7BmrmfKgraVIEunDZs6gO7LUxMzLaK5Ngv4hMTk0iqDK0D6WLEELSSihSNuEJi0myAm/CkaQggbBpOmRAfMqoQE5BCwcz8pZloTzOIqZYNMsSShzY8AhnAvwX0526Cpgl0DdZRUg6ZCEZ93TPZ8vl8uuCK+7YKFesdb13g3OL98PL09ozWbbdLZxoNopPxuU1UUUlMfr7PTsZfdF9wdamxrnga6G50LhVoPJK3ZZ3sIaAa91yv/pu0eR3B7c3EsTATbZFL5aFxR+w+9fFFQLLwWdWdA4fhOR419/74tHv/HNoUbmPHSifToH883hM9pxvZ4IJz/ZZLOhYQgwC/K7wc97YUOC5pSPHUmU8P4UeSqfcObRx0K3H7MnP+a0uqOkXE18GwgST/h5R4zc/NgT+sD34Dr4Q893YN0Jyua2ug0Fb+ZTiEBTX1u8J9g29Wb/5vIapPg3tgf1Eg==
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: eJzlWN1u2zYUfhWCVwng2Fna3RjDsDTJCrdFE8wpsiEIIlqiLTayqJJUHM/w3Z5kj7Yn2XcoWrJl56/ArpabSCJ5/r5zvnPoBU+kjY0qnNI57/MPw/PP7EqO2Ec5Z0Pp2N6Hq4/DfSbzpNAqd8ylwrHC6HuFg3iTrChHmYrZnZxbVlqZMKfZvTRqPPfLVk1y4UqD3XrMPlxdYv1O5pYpa0vsHtE2Zdl5IfPBKbuoRJsuu0yllZVYYWQlGpuNzOYqn7BCGKfIBGgTmUqEkwzng3CRJ0xDvfH6cRL6C51babu8w3FWTKWTxvL+9aIVAuglQTCWzNdmInJlhV/scEU7CuFSPOeQgbf1HYME3438ViojE953ppQdbuNUTgXvL7ibF3TCOgMP+HLZaev+kqtvpWQIQO7UWMH8YIaFQyP9sGFOd7c9Yeu5mbzSmhvaHKJE60eHh/TvRQkCRbHOHcymI6IokBLeyN5XS+cW23r16KuMHaFhdCE9mLRKgK/tEsaIOTnq5NS+4LRKtl3rtHwg0wenHR/YciviY238Cgzhyw6/c/OXSaQdlczYzAunJ0YUKQpDZBNtlEunbCymKptXmTzDl3U1sbl/Xs1Jae6hoxEgs4wWYxbTii8WEgaVzws7XtlVGd2YqQjHBCooEtC1ZSu+PS/+oqYFklHpqCWT1JDZDX2Q6IfnBf/OYq1NonKq+BVYrUB4riJ5L8Duj5fLC38dnkqRePZY0NvbqlBeXABNSV5zaYw2JzqRsMs/n64Zh4p8Ot2b042bFOSJNCTvQUyLDN9g4HKH+B2hqY/wdyIBXkXpWM2WPHi/GT/aSB5J6zxpb3AUWJ7l2iGuZZ4QYbUj9/ZVkWtHwynnjV11DeZ93IL4jL6iJ9hZw6jtfrM7ts+nD3nstyKNEuQ5ZVCIIotU7nvTbYhP1GERonHroxEhUCyyEvllbr2EiK9Quk2ehmnbBCMFotXkrzfeo1VDWrvEaxv4Tn388woxvgPverFC+0JYO0P9ZNJa9klPVA73gaYl9FMB+CUcZCMpsZCLURaI5amutpkkP76yvHQuz8e+sf+X6ULNeyXv+GKwivjNzoCvo/xIzAfwzuQiY9XeBsEtAHburMAINlPYo5obIj8NRe3yj9gsBSbKsVjkVKNIobji+WKtKNaxgClUIatRp88n0p0PTk9oBBhWWFKUxYTmKt4KGdsb7oB7n0gO7JLqIM+PZ5hn+rx3/6ZHLqpY9uqU6mmVxL3F5tC17C3Wp55lrzsDgR/c5XqGBJnd2a7Pkk7AYdfUdyqnOgQU+0qT4VvqXGH7vV6CtQNRqK5CT89dV2m+PbrBzaSMPec9IuY5CUMEjibbR47barltyA15hS6l3HxIJVCR13GhMJOsz1HVhzAxVqA2M+NxCQCM+nM15rYmBaQ39XGBXTQmVZVXZRz4rax7ebQhJ2KVGjYtrQMBIK3kWD2sZpeospFFbA/ZJ70AZ4TKfAwKEcv9DpPdSbclts/CwZ/mujQUjgMY93NEJcnfSdwVDO0n30f+7VdtpsLR7Hp1ue1bHBNx+WsDOp2tR6tKUrAZnZBtGMHqCHreoRhWynjdsgk3mvER8bFeEZiIPYGBqRRha8ui0Mb90uBZQ6LeN582E2E9h1re1IfY3j9//b1P3Vew4UwmyqYMVyQBbo5TkU+k5wR/TQtwslBqTfGzgaNBzWIlGx9Yjd0Sl6kwK7t5J5wnTsfMK/1nkdkOdCZqohwoaiayDJcEUmY1OiEmKVwQZZzmOkOvkNjsmwJhLtAqZixDu8gooWiO8Q1ZjJATbu6FIAU1wKTtsQbLKpHHYUD17hk5KTPvjyXMBBuXWUaZm8AcsnMKrquIDR0ElOJpelUFSDok4VH3cCvms9msK/xyF9TTC2dt79Pg5Ozz8OyAziybBtPgQLWT6LicIjir6iIKqvA6Ojx6233T/YHOFto6WLdmD9EqOws373bmrjXE/8mtPdSVQy/oFZkAkS0DTIvQMq75/ZvA8gDIj7OhbeCZGgf+9bfu6/3WjXmteeCtaR9g2hQYkZrFYiSs/GKy5ZI+Y7gzINtrPN4L4wuiajFQQwMP749RF/IJBPd+C3eCffbk7w87Y7Ci+Jz43RMy3vBId6qt3yd83/keu17928R32LqBxPKmvmn5aFZbiLALt3Z4axhcrk8U788uQcL/AoJCocs=
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: eJzlV8Fy2zYQ/RUMTvaMLLlOetF0OnVsN6MkjT2VO27H4zEhEhIRUwADgFJUjW79kn5av6RvQYqkKcV2Dj3VF4vAYrG7b/ftYs0T6WKrcq+M5kP+bnz5kd3ICXsvV2wsPTt4d/N+fMikTnKjtGc+FZ7l1iwUDuJLsryYZCpmD3LlWOFkwrxhC2nVdBW2nZpp4QsLaTNl726usf8gtWPKuQLSExJTjl3mUo/O2VWp2vbZdSqdLNUKK0vVELYyWyk9Y7mwXpEJuE1kKhFeMpyvlAudMIPrbbgfJ3F/brSTrs97HGfFXHppHR/erjshwL2kCMaS+cbOhFZOhM0eVySRC5/it4YOfLUlRgnWrfxcKCsTPvS2kD3u4lTOBR+uuV/ldMJ5Cw/4ZnNHwpVdtH9yfEz/XgQJLoqN9lJ7OiLyHCAEGwafHJ1b795rJp9k7Ml/a3IZwke7FOKWlLBWrMhVL+fuBadVsutar+MDmT4674WIFlp9LiQDyNqrqQJEU2PDDgzhmx5/8KuXaSSJUmdsV7k3MyvyFKkospmxyqdzNhVzla3K3FlipX1NbBfPX3NW2AXuaBTILKPNmMW0E9KTlOHK55Wdbu0qjW7MVIRjgisoErhrx1asPa/+qi5E0lHeUWsmrVVKNwVLqr88r/h3FhtjE6WpxrZgdQIR2IH0vQC7P16ur/rr8VSKJNTrmr5el4Xy4gJoSvKWS2uNPTOJhF3h93nLOFTk0+nenG7cpCDPpCV9X8Q8z7AGAzd71O8JTX2EvxEJ8MoLz2p+4pX3j+NHguSRdD7Q5COSAq8ybTziWuiEyK4budffFLluNLzywdgtT7Pg4w7EF7QKFnZLiFR512X4/bF9Pn3I4yCKNEqQ55RBVRRZpHToBvdVfKIeixCN+xCNCIFikZPIL3sfNER8i9J98jRMuyZYKRCtJn+D8QGtGtLaJV7bwPfexz9uEeN78K43S7SvhHNL1E8mnWMfzExpuA80HaGfCsAv4SCbSIkNLSZZRSzddrabHN9/Y1kZLS+noYX+l2my6a1rfadXo22k7/YGuo3uV2I9gndWi4yVsg1yO4HfK1mCUNlM4Y5qTojC3BF1yz5iyxRYKM9ioak2kTpxye95qxjaWMAUqoztUDHkM+kvR+dn1PopvGJGowvvxIod/CKQDQBPaH9IZAYWSU11Pgw+mFyGfLB4NSCXVCwHdeoMjEriwfrxOLMZ9Jdg5qMHbZbIgOWD64c06FWB3jdAncu5qSIGucJmWEu9z91wMEiwdyRy1Vdo1tr3lQnwdhqZNUkRBzL7iprnNIwRIBoSv3LcldtdQ+7IK7Qf5VdjyvGSlU5zhWGjPSCVC9UwWKLWjIOnBSJu1Z/bibEzAiB/qUELSNH8U5ZWmVIgrqJu0tEjPRErr2HzwnlUNvJGTtWX7VASlTayiB0gvWRQ4K1QWYhBLmJ52GOyP+t31A5ZdfCHlSksheMIxv0YUc3xNxJjtyV58n0Svn42di48DaU317u+xTExUpjA0cJcPTOVmiqb0eLYIyNYHcFALBTD8jJe92LCjVNNKD01W4YScWAoUJEibF2R58b6nxo8a0jU22bpcSK0c6jjTX2IHfzz19+H1FYFGy9lolzK8NoQIN04FXomQ9GHF08FJ6tqq6luNvI0gTnsZNMjZyAt8S6phmC/6lXniawxzMqwLDLXw52JmikPDlqKLMP0T5c5gxaHEQlvLRmn2mRoAhLCge0Jc4EesGQZ+kBGCUUDSui0YoKc8KugBCloACaJxwY0qoSOq8kzuGflrMiCP44wE2xaZBllbgJzyM45yKxkLrQIcEjg4W0VIOmQhCf9452YL5fLvgjbfXDNoDrrBh9GZxcfxxdHdGbTdJAGB6qdxMTFHMHZVhdRUInXyfHJ6/6r/nd0NjfOw7qWPcSb7KJ6xHYzt9Xx/icP4KquPMh/kGfoGeGRQTCtqx5xyxevKpYHQGFOrfoEflOnwL/hztO31Szw1bQLMGsKTEjtej0RTv5ms82GljGlWZDrLX4uhA0FULYUqKXJhQ+nqAP5BGIHv1bD/SF78um+1+ctpWvi80DA+MJPehztPO03d/VDJNhYChHt5b51fGdm2rQb8duLa1DZv/KHIDg=
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: eJztWNtuGzkS/RWCL5MAsuRc9kWYHYw38Qy0Oxgbawd5iA2L6qYkJi2yh2RL9gh62y+ZT5sv2VMku9VqtXPDLrIPGwSW1F0k63LqVBW3PJcus6r0ymg+5hel1JPX7JXRWmaevXHSTvTcMKnz0ijtmV8Kz6z0ldWOZYVQK8fEzFT0RjJR4a/2KhNe5rTopMIOQ/ZP+VulrIQoW4tC5UxkmXSOefNBamZmXiiNBXNrVmGf+Hx/qGEzyUpr1iqHmNJBaHqG04xVvwtSfsqWUuR02DXeNUvpoNI79vP5NRM6Z5cXV9dDdm6tsfjtNtI6ZuZhv7S/ZUuxhik4f1X6BzYz+cMgrA2Hvn379uSsZWZ9LluaIndBxkrhjB7eaD7gpbBiJT2O4eN32463SVN4O51v7EJo5YI1WKlIohR+ie8ae+BXW2KS47mNfs352NtKDrjLlnIl+HjL/UNJK5y3Si/4bjfonv1Gq98qyWAwDJkrGJDUcDB1Zu4P1Bn265NEL+ziC7W5JWFXGu2ko/fPT0/po6MhoINYz41d1T7JjPbQl2RFWRYUALwYvXe0YHt8oJm9B4wpDNaU0noVj3PV7FirwScdBE2ChwjTA0TZmWINOG6UX4bnURSQgb7ZEnsy4bH3rPJAflqbiaKYiexD7e2sUGTQgMt7sSoL0ue90HKYG/ljejTMzIrvyAbpIBt90WOjyHNF70RxeWDt58lRyHZdH1yHtAjHwtAMsSULReEoy5Rj+C8of2nnAdPG009hrXhAjolsyT7IBxIK3tG5vCezBWtbwgSxQozBAJ8C+gTPsekNP73h07QTeAPR2CdZ4p7gRgi3t4zZqpD1CS8sl+A1LDSROfaGsIiumKtNCLY8wHENd405mG4sq1yNS5WPn5HYSqji0TjFfwMeWYECQL9eRoB/Nn73qfSOSyKrVyaXdDZ9f92KETLp41jfr95DAcQoF9K2TYaCu57te7JkD9S/CeLiEtzfsBxP1h/CiATJIul8pOeGamsKDjl0QLmfwbgbPAJ20s57JZjJsgqbroyVhA4gVGcynhwPBMU7Nm1cMw2HTbvWT+MJXW4mQBPU56bSOTHjPtS8q2svK/W5UgoLtVA5itVfb7pl+DK564YPWFASIkqHSnqXrG9e3bVcD7HLpv6wVQUnoY5WgdhuOO9N96RJtgRRSb2A2yY+pV10UNtZ7cNa3mrCu1DrUPRTReS7mAvPeshei1TNZZ4i1W4R4PKVci5wBPk+dhHgVHlfUp7EJQE3EA0oGh7Ui903DlMw47EgXcFQAhahMhn0LcPz4jg8Pxk7UzlIsyc2oMCYEKFvCi1EBgZiU/zRKp/+D8fGVfO5yqgC3wWdHwvQJEaRfRekvovFJ/ShMazfLlYvv6isdEsFupXgu9o70fijVqjdLteNS/JvvXLYX3g+3WaFbj3sn4GJB6HJSkFl0w7JTQdsCqDdBeadUvpP0Yqtpb2L7uR1CbvLP17DjlWIbm1avKh88HGrK0gm8UYH3nse/7WuDrynGDYvY15cCuc2xuYFJdQvZgFQyXtEsyEELWEgeDsMRGJW0JyUtHysVT/sPf7yhb2H0fJiHqaV/yZcaCKp9zu7nNQev+11eDvKj/h8AusseloWZfcRPApAr+RXdwfKo6fXRH+AULY8SNpuLKCKk2hNMCME/0aCILLDz1uynRKoHu/GfCH9pXH+YvL6VT2JX8WQUzDEgmZK3vEse3LVg4qn1CiiD1ga2rfEpmE2pYP5aP1iRK5QmRw10BsZlWej7eHEuRtt2yPfbkSTEE1ofJBC1DflvpYrk3wNucpS77z0vnTj0SjHuxNRqqFaWKH9UBl+PKrCtLzKQuv1yDaf2uEKzqKp4pHlLr7uKnK7D9cVZUfktbNS/UM+tFhFxAdpQo7x3s/IB5cUR6lCyKcZqXVxQjkcwBgnnpQ//ZcdTU+H8Weu7uthdBp1ZFP2BMCMNdlbTC3BB6XI5FPUueFi2Nl2zNLC7x9MZckdJ1Duhyll6wFYt3wWfv0UpifY8fe318e2tZuEEjRXq5fqYtSZquiBEqzxYKAk8mE8jDejDsWN7jR4wF7iNpEFbqunM1eVpbH+x308m5Con/ePDoHQxlDHmmYRe/Lnv/54GkZfdrWRuXJLlgsvQNuo9CjzgS4AMzVP4WQpu/a8QI0AcsfhTTE/cQbSUi10c4MwSOuJ7ttjNyZblquF8mCvDXUVPhzmDDUnpcHAJLOlNgXKiIRwqBdhmkYV2bAClaQgQNH8F2q1mAETPs5agKChixaIY5BFgRAYmmLAgnlWLqoi2OMoZoLNq6Ig5OZQh/RcgQYj56G4gEUCg9dZANABhM+Hp0c+32w2QxFeD8E2o7TWjX6ZvDr/9er8hNbs9rVnHwfKndxk1aq5FBlwoqAYr+enz18OXwyfhZsT8B20a+nTXGyep4vCLnpb9fL/l6L/6UvRlMYe1WZUwl2aghRQsU1F6R1fv0hFBXgIfX4qTPhOpQkf46Pr0HHnQrIpT2DyJdU87LvdzoSTb2yx29Fj9JWWijG+roUNCRdLGPalXouP58g7+RF0PElxzJ+yj97n9hpdlxBN9SMQPn7h6weqMN373lDXvkavL77r/QpdD1y/u21muuDNKHIWYNdafNSH7tpdCqGSritTxUnHN7UgfWn1qYeafZ/KzDWlzQ+NniGLSMHd7t+1mNX3
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: eJztWN1uGzcWfhWCN00AeeT87I3QFvEmbqHdNjFqB7mIDQ81Q0lMRuSU5Eh2Bd31SfpofZL9DskZjX6cpost0osNAkuaOSTPz3e+cw7XvJSusKr2ymg+4m9qqcev2EujtSw8e+ukHeupYVKXtVHaMz8XnlnpG6sdKyqhFo6JiWnojWSiwV/tVSG8LGnRSYMdMvaT/LlRVkKULUWlSiaKQjrHvPkoNTMTL5TGgqk1i7BPfL491LCJZLU1S1VCTOkglJ/hNGPVL4KUz9lcipIOu8K7bikdVHvHvj+/YkKX7OLN5VXGzq01Fr/dSlrHzDTsl/a3bC6WMAXnL2p/zyamvB+EteHQd+/enZz1zGzPZXNTlS7IWCmc0dm15gNeCysW0uMYPnq/3vM2aQpvp/ONnQmtXLAGKxVJ1MLP8V1jD/zqS4xLPLfRryUfedvIAXfFXC4EH625v69phfNW6RnfbG5I2NVGO+no/dPTU/rY1YfCDe9OjV20WhRGe5hKsqKuKzIZL4YfHC1YHx5oJh8AHDLcmlpar+JxrpkcajXYP16rnxvJEAP4dqqgCzQJriEUDeBXZ6olALBSfh6eR1EECfoWc+zJhMfek8YDa2ltIapqIoqPrZuLSpFBAy7vxKKuSJ8PQsusNPJFepQVZsE3ZIN0kI2+OGKjKEtF70R1sWPt58lRyDb7PrgKQAzHwtACsSULReUI18ox/BeUMbTzgGnj6aewVtwD1aKYs4/ynoSCd3Qp78hswfqWMEF5GGMwwKeAPsFzLL/mp9c8TzshUxGNLaxTtgc3Qri/ZcwPhTxLeGGlBJNgoYm5ujWERXTF7OhCsOYBjku4a8TBLSPZlGpUq3L0hMQWQlUPxin+G/CYhxQA+vU8Avyz8btNpfdcEj28NKWks+n7q16MkEmfxvp29RYKoCI5k7ZvMhTcHNn+SJZsgfpPQexXg207XuHJ+l0YkSBZJJ2PhNiRW0t6IYd2SO4zOG6FR8BO2nmrBDNF0WDThbGS0AGE6kLGk+OBIFXH8s41eTgs37c+jyfssyEBmqA+NY0uM94PNd/X9SgrHXOlFBZqgaurxTfX+4XvIrnrmg9YUBIiSofadZus717d9lwPsYuO8dmigZNQuZpAbNecH033pEkxB1FJPYPbxj6lXXRQ31n9w3re6sI7U8tQZlMN4puYC0+OkL0WqX7KMkWqX5Th8oVyLnAE+T7WbXCqvKspT+KSgBuIBhRlO/Vi84XDFMx4KEiXMJSARahMBn3J8Dw7DM93xk5UCdI8EhtQYEyI0KnQAa4AA7Ecf7Qq879xbFwznaqCKvBt0PmhAI1jFNlXQeqrWHxC5xfD+uVi9fxPlZX9UoFuJfiu9U40/qAV6jeobeOS/NuuzI4Xnj9us0J/HPYvwMSD0GSloLJ8j+TyAcsBtNvAvDmlf45WbCntbXQnb0vYbfnpGnaoQnRr1+JF5YOPe11BMol3OvCj5/HXbXXgR4ph9zLmxYVwbmVsWVFC/WBmAJW8QzQ7QtASBoK3wwgiJhVNJknLflXaLUR07D/+ZM9htHwzDXPBXwmTzWDd7Xd2MW49fXPU0f3oPuDrMayz6GVZlN1G7sDxRyX/665AefTymmgP0CnmO8m6Hwuo4iRaEswGwb+RGIjk8POGbKfEaQepEZ9Jf2GcfzN+9bKdeSkKYkZjG99zKXv0oyAmAji0f0wNIer93NA+NTYJUx8dxIfLZ0MyXRVy2EFsaFRZDNe7s9xmSCOOisdGbx0bGF/JhUnOhFxjqSmee1+70XBY4t2JqFWmZhZ6ZcqEyO9uABPKpgg91QPb/NEOl3AKjQsPLHfx9b4iN9t4XBL8I2Gd1erf8r5HFyI+SMNvDOh2/N2Z9w9ygaBNw0/vDoKSNKAtjjIpQY7fG3TNGuaaqbprp8w86shy9gjIi8XWW4wjwQe1KORjFLBslu1tO2Jp4df3prHkjhMo921O6biDxjWfhF/fhbEIdvzr3dWhbf3qX4O/WvVSwYs6U3ncUYJ1HgycQz6Mh/FuhqG4cUqXgL1EXqII5NWOXa6pa2P9i208u5Co77ePdoHQx9CeNd0i9uj3X397HGZadrmSpXJzVgovwMco4ajfgQ8AMzVN4WQpnbaJTxUeuePwppqeOANpqWa6uxoYpPXE4/15GiMrK9VMedDTitoFHw5zhrqO2mASksVcmwr1QUI4FIIwJqM8rFiFElERoGiwC0VYTIAJH4coQNDQDQrEMaGiAghMQzFgwTwrZ00V7HEUM8GmTVURckuoQ3ouwHOR1FA9QBuBotssAOgAwqfZ6YHPV6tVJsLrDPQyTGvd8Ifxy/PXl+cntGazLS7bOFDulKZoFt1tx4ATBcV4PT19+jx7lj0JVyIgOGjX06e7IzxPd2776O0VxP/fL/6v7xdTGnuUl2ENd2kKUkDFOlWh93z5LBUV4CE08KkS4TvVInyMDm4Wu3IE5p5TUcM+6/VEOPnWVpsNPUaDaKm64utS2JBgsWRhH2qa+GiKPJOfQMOjFLfyMfvkVehRI9uSoaleBILHL3z9SBVl/6p0c9ONPEHHKHQWgtdbftCubfrFnWJLt3mJt5MCHaOmL712ble3rxNZXxH4vu00DVgkBTeb/wB7/VRk
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"}>

Access token passed with Bearer prefix in Authorization header

<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: eJzlVsFy2zYQ/RUMTolHphTbvXgymTqxm1GbZjLjZHpIPOMVuSIRQwADgJJVjW79kn5av6S7IEVSlNw25/pg0wB28fbt7ltsZIY+daoMyhp5Kd8pH7wArQUsQWmYaRT4GNB42vdCGREKFKWGMLduIUfSluiAjacZmWsyv2mP07ZDX9IXenm5kWeTCf/Zv7E7LtgaM+GrNEXv55XWa3KRWkMnAltCWWqVxuvGXz2bb6RPC1wAf4V1ieTQzr5iGuLd3yrlkHB9ll0M8m4kS8ewg6ph9faOeNlHeyUWUAo7FycnrZmYXvuTE7EqrEexBF0hE5UxUKRVJMbcF8O8dSbKCzTMbvbF0CWQZYpvAP1hD9o/hlTbH4mn2ejsZ9ZqBHMQzbRBSXjnlFgGdQSh3I6kgQX2HPrglMkP/F3jXBnyxrGyBRPVxh3PbAcm3+Oxt3PEcfMzkgVCho6Z4P8uJi/4lv9cRHsMO2fdG5shwYrf1z1sRPswO4M0tNZdlIpQ5OjY3yMsSk1rF5PJ9oj7I8y0JvI1ZFRhZRVECY54DuSyiX6fvk8GqlBYp36niIbU/FC34/+Umind56jhhEe3RCfiNQOOyMhjWjkV1hT0Rl6V6hfkz7vtaCNfIzh0V0RwXOGoIffMzq9gIEfRShszQlAKyxqZYyQE2EyOl+djSsBc5WPs62YNysdbhx2xsA1mOlc5TWtFCKW/HI8z2juFUiUqd2BCoqxkoPsOSGGyKo1d9ISbf/NwS3ES70+Z+3p7COSuI/OWa6ouhR2lbU6hXhhRQbDPmA25EyB51ZRzrNFDdf4wFQ+4Flz0rAt1KSfiY9EI80437vf83Iv6GrGofBAzmm+OZOeRRtFKhYIOR0jiXjwzliSdHQRH0zFyUEKKz0cCkzwZuL0UjeHLta0c03FK4F7dJ6yC/eLZyFn87ycaqUCNKH/+7eNhbHEoimAf0FBte7+DV3tqMPOE3gMhWgZjI8dpEA1k26ScN8m1rszc7hQB0qgI1PqKc+ursrQu/Njls02Jetst7RdCv4YG0bRG4tlff/z5nKcNiNsVZsoXIoMAJO1pAYa6CEwmqMzUvElnLDuVcpbsUlFsiZgGUdEbg3b0/NRbOo0qpxGWcRGE9aixj6+ZlBSMl0H7Ed2ZqVwFUoEVvXkwxMu81SoTpc1EwLQwVtucdGtUj0POOQiDK6FxiZoLipUryhvMqCbCOjqhErSUTD6eWtImBYYgx4TF8BzmlY7xxFcViPjcITN6CEScCzCGYiNSSZJJGKJW7rqAio6K8CyZHHC+Wq0SiNuJdfm4sfXjd9M3N+9vb07ZhrJBtOi95Anuncym1YLI2XUXS1Cdr7PJ2UVynrxg29L6QOh6ePjV2D0dhqXbGzHf/75sajTQoTEtq/iEiCFvGg39LJfn9TORVDTOgv5Tjx5lgc9sNjPw+Mnp7ZaXv1XoopBTkOBiZdSyvlMcFt4HFqbYeCVLdlSQqFCDKbnty/vbG+5daBq7E7WHKGrNB3vfbZl1z/dQ32oI/Jtl+KjJS84cycyr9ni986RBqwj1aab0jmbd37YiNvc=
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: eJztWdtu47gZfhVCN9kFHDuZwy5gLBbNJuki7Zww2WAuZoMxLdE2NzKpkpSd1PBdn6SP1ifp9/+ULMmHmUwGLVCguXAk8ed/PpKrJFM+dboI2ppkmLxXwWm1UF5IkWsfhJ0ImefibaHM1YU4t8aoNIg018oEL1JrJnpaOpWJiXUizJSwbiqN9pIQ9oQ2aV5m2kxpTTuxUE5PdMqrwqm/lQo0vAoBIKBpsg1KBvF98RtwGrUkuEgVEHPwN9HOh764fvBBzY/n0sgpuKgZk06JXE3AfxlEaXLlvRh5hn0dQUdC41NwpRr1xaVMZzX6mc0zrMS3a5U6FUbM2SiFJsYyvas/aoM9SkJudR/6SS8ppJNzFZTzyfDjaku1b8r5WDlSqFOpdaARrPB3umDVFXKqDcvcF2cQeIrnBWkT3DslMznOlVjIvFRiAja8IEYIw+hkRKQ1kYA63QNeDLjAq51MoFq8k6I1jJQMsderXuLTmZrLZLhKwkNBoNoENVUOsJmayDIPyfCkl8y10fNyjuf1ureq0eZ6rsM2ya6sr+U9bRRmn8zQXemMKBRLrfpPZfA0ctWlfK0Ca4UNS0/RAxX7pt/vLLAjrZK/Q/nmQVi8ukrbMDCFA77MyZkO6brjW4+SaGwtcJu2RAy6Xt/Sdl/A/ZWnDc9OTuhfV9BXVXRWQgANIifgkUBlUeRVlA3+8AS/2mXAjv9ALHd4/Zg06BqPTMBQ4SwMFnTkqIZqkEnnJKlDQwt+H5EuggICAgOjv1AT+Bk9XWWtnR6ZyEx3XIvyATIRJCebRUaOOpmojVtkG+QUVweWxFjllhIQ/EUGMbekWlNj7yfr2syPYY4gu+zR/vj0VAEbDDH3PA6LZ9hdTFASzJ2Gm/dXjzFhRWG9jwRiRGeiRigI46YSVNrjDD6qQT6VTo+4qhghyzCzrqoVm2owL+lHBmRkskHkfi7UvUxD/sDGQAK0S5W9dRou+q0iLNUYaZYxEbEHWzrRih8mWGd+yPc41QOQPGk50xBDovSU41GVUJYa9XQM9cg8LXMZ4LFUXWJWpJeUMiWXTBuzFlWltueiXs2L8ADsyrQ0LUrkCzHSGZ51eHhNKgSaswA2x2VQftT/3bSleYIvgUTGUZKmVFKJ+KilHJTS91Uyidx1FqnioiCxRg9zuS95yCzjQJX5u04a+YJ5z+BHBSdJMET0ZC4i4YlGkSZB0lzqOepQmPkonPQoBOaO9M/2iv5csxsdE4tVz3CnHhqM1DQ1lIZRO4s01P5+fXH8lw+/tUB6ESSzKQlSg83x3gECfbhQBIk+RIDiw/PzFliMs7iso2UyG469oqaEnIxkrF0qSr3UYca1D566HxEHH60y/FjF1ouZJo/+vCN2/OJ3KnSI4XmRcx6Frw8VOsNhobPhKWyF2qTzBBU9CU4aj2Cn0iCDPEujNXe9dC7vXykzDTP0Ai9O9nktNWZRgrg2rrjP7ZQEj8oAt67uAS5vLq7EBzCuQo8NX7EsRq/sVMQ9nCGsgZcodGHmjiO2NGFXHYfKzQxOZkC8EVRkkHRLScmXSZLL3+mnV024L6HoNi/7W5Q2tiuTUXaEMiEq90ot41OQd/ssqNFYaq32N2DIhAbrlBPLImNfxY5MwQYq42RRfT4LBxrCHbPrpgTnEuUkIuiK36NQl+LG6Hve4AP0TvpGqrMm821TnP744seT05doxCh9oh9/Kje8l+z9jayc/gBW1hQtrTZtT+JEzmJXetdA7fRypXPgARDqEQKdR2ju3Kv2vsMdxa8NMr/aqsAHFUTArTmBK7eQCyQDGnnauJ+9rJETr09BTkzT5ER5HjaoB5kNhecgED9+GfebLZbrcaajDXIXBPs7pxbalv6rQkuzhzh1RK5RVBh2SMSRgam8QbJ7OgVDqXIbO01R6/gHEhhDebRdJeeofer4HAOHs/ne4WKTh5p0ZuyxD9ap3TrdsMS5mgKjHoCEn9kyz0SVIFIiTEmBGHoR56JHzz1oJ99OeDI/GCbOLlDOkfads7s2v6SvKNF+GS1PjFYnI/VOylerDb6zd1cVKhrqWuUvfiTv4g76U9X8kr5o5dO2fmKffRQn+iPKj0fsqEdJtE0X/heZ1e10rOZFLVfk3XPpFyOmVR1u7NAdVR1cpDkimiOmyX0c2UNWoRVpVGqh2haRndtMtZFf7OAm/b2T3i/R8PIRzSuuy/BEZTxlyYqQMpQLMpq9GyeMHnD6VR7QnnQ3PNZKb/FHE+/nB9hm975UsbH0C64YO+g/GydkPW2KksKxOk9K1vvMfGOqCervfOTQVc3L//3gQF+2UO5TTW5/ZEA7GAtEhK3x7VHWXsgne67edC0o6JgDQivItt2UGiyFKovxgfV7Vui/Knq8JW38oqRT7qykLhZfyPHklM4Pk60z1/M4vwMALjGz8OFkyqd71NjjZbB4PoinIINNAA2sztJBc6YTZd93Onmh5rZSDeBKh6yezEIo/HAwyLB2LAvd11N0rKGvbbJ78AYbZ2XsZQ+g+RKG60BNyvTQdh+Xtxm5bbR7Tc4cw7PWcXMyED9Uh3fRPM3p3VkVR3WHtDVGwlFp0KNooxmpOhjYnpMwJHTwjEQkE080xjwOTPQ9jcacfSOPYiS+gx/FA0pMBDpnHRQyVd/3hOpj0uyiHYpq4080FZA6jsHczyPulNvetErG/PZn6zC1Qg4Mn7uyVYO8vYNXF8jFNXsRU8Uz9aIdJsRGg5xBuN/gDckmcZLdeJ7TZmLrVIRphyOchz1EeFkU1oU/NfbcmET/2nzqOkLbh7ak2WwS3/3rH//8nuqHFNdLlWk/4xELtSWdSTNVHN2d2whyO522wlhcVZOsV/nk2FtAKz01m7OAXrWfj+ab+dmjmxeZnmrqPZc8SjIxb6mEFzbDVJrOjKUZVAGYixvZnHqwpcjVQuXcVlLCopIjx/AJjJWEBC5oYUwCxyyOfC5NqqLBWDynpnSmRFcnZDMpJmWek+dmYIf4xOhlYopCLUCS4IRbR0FB3ZV41j/Z0flyuexLXu5bNx1Ue/3g1dX55Zvry2Pas25KRWMHip3MpuW8noOBmlJQtNezk2cv+s/7p7S3sD6AuxY/fMT99urivM59W+ZuVbf/X1x908VVFbL0OihyqfmYkD1gVZWXj8niebxjgJDcrlQlBs9UZJLe5lIAGXkGW9Ke1YqGrRuXr9f0Od6ZcPGBoqml21yPHDTsf/babK/gdCrSuj3j7fgQS9ajGf/aO7DPsFIPqk/k5L9xJ/YZ7revxhopbunFcQKN7VBdmMlF4maqT0Vb9p0udt3uiH69pBInq/rX1P47rv3VQ6vJleahhXu7DYgsxEOyA1t+ogSHavzzBjyuHNywKZwRmhR1ix7x34yzFXU=
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: eJztWN1uG7sRfhVigR4kgLTycXJuhKatY/uc+jSN3dhBWgSGRe1SWsar5Zbkeq0auuuT9NH6JP2G5Gp/JDtxgF61F7akXXJmOPPNNzN8iFJhEi1LK1URTaNLy7U1zGaC8cpmSkvD6RVb5KqO2RW/Ff6t4SvBSq7xYYU2jPvHv5xeMS3+XgljR0wWjLOF0ismikSlImVzla5j9kHYShfYU7A/Xv35HcQsBaszoQW2pPJOphXPDUvwnowQhZUJt4JVRhZLUiM1O/14csY+8TwXFk+0qpYZ+8sHRmqY0iwVomS5LG7ZndByQftxipgdLWCts7TVxEotDJT4EyRapKQRFozcA2cdHkotkrBmrlVtSI5is+bNTaXljNXSZmxGVsxwvJTNjIXls5h9wjGGelMFZxbKYqWpIY42w2c//sRWsqis2G+AVyG0VvqNLHAcntDZbsjtWJJC2RV2iSItFd4zniSixD4KDZl0cX55FUejqA1eNP38MMABSTg7YWrhLFB6yYuABOyUtKLkNsP3AjLwq7viLMXzxppoanUlRpFJMrHi0fQhsuuSdhirEc1osxkNdX8sJADEpAvDQsIxwQwD8+fqvmdOvN+esPRcL59pzbVfDPy+BVZpxXBvouD0wtIrXpZ5gNbkflzX9ZjQPq50HgBPi3Z0qfkXBJIioFUptJXC+HWKXg9NGkWiqFYIUYTXhUwjWJiKBa9yS7L8s9Ge8Dl5jesIBMY0qRlt6JSmVIURN17d42rpIH2l7sk+lSSCNDaykYbGuQ76klzCazcy3afrKfD5jd7kNtW+TcrHD2eUpHUmk8wJ21pWyzxnc3gJsmN2ZtmqMvjHLRaqYuu3RiVJMn2LmLhH5uXrmExzaf51m44KpkpO6L7jeUWMBlKEgSuOTMUfc3Jgl61F4IsQMpe6Tjk4b86TW9JaqCL5Fq3Mvxgo5caoRJI+3hzJACTE9o5jQL+IglW3ohh59TBUWrmkLVqUOV8zbi1sMZTGnUT5HMA8RFkXBYNwNi683mw2HXS6zDg8OKCP/qG2RYTVYu440vOeY0uTgaCdu5qa0LjP1QSbccsodfyaTi0JRD3b2jlj0rCquC1UDS+gstTufZ/1t0Tu8cN7sOmjpkPprZGOzJ2JhWr3Wlds4eZEEMt1eMeKezvJ7Crfyy9P5IMrt0FQYxfZEjmnZ4Knrhw8RH8d/0zVYXzudpu+HgB/Veak6uT0/d8IiH1Nb3MFTPhDLrRaAc+EPo2ShBqfUl/gDFmQCrQJ4VOs5iJ1PvYMyUQuVlSXR9i65DrNicKaWiAJt9aKFbRSV6AQBWZU7I/y6uBwFzJXnXSSRIYLSgWnkUR2OwVqPiighvqhACytULdRjZ7VC9ASaNTrbrPkq/dsFL7cdMzstw29sPcj9E55S5+GQBuqzNrSTCcTD8M4vIgTtZo0lPL7pqkAT8j0Jrjqhx0b31xsj/KbwwMiTnzMBf5VrnT/4Kx/wxcHcvHF5Ontl12MXA3ItfWWT4bWWyGirz0JPFJ9v5ihJ7ps5EQe+6rlvp90bEFpe7owt7tbB1PjtRS662EYuNkj/smgvOWUDWVl2/PSaTe7KYWFIR4DNPre0WwpmxJi7RptT1XdGpKpPDUE00DKK+pTvbzQgma8Qedx28MOzzRrJXdbMcopypmFqoqUoNui1Qfw9bMCOAyKldb57KI5uTNrh+ZOA5e64wSyOAfVo5Q1O+P9If42CvXwpJoyotmGhWCy2SBtKLvhjRvnjRlxzAw0AY658ckfNWC5SZ9Gy7684YZGssBb3ngHmi2ytkeKtjZEe/VF75uIRXtgt33pQXKBlqFWgYjfqSWIHJUIZZSiT9ApBA4Iugc6RMHnOci+sfKx5r0Pkp+emeVo1c4Xbn75b8KFZpRG3tHFWePx670O70b5EZ+f0dhWYAL0a9sI7gRg78rvzlhpm7oGCIWOuOwkRTcWMIUypJnoMGApY8/PTo6PMJJf+mCSm/mS5sdo4DP24nJPvF8S2YLlMtUIdHMoBrdpNLl7NaFDykRMtqCaKJkmk4f+dLmZPHTHu82ELgmogXQu2jfNnoiVCh7EOoxnnXqY4t2YlzKWS81RGKWKdkdSHCut3Jj9mJivSbiEo6hPeWS78a+HhlzTqRJ0E3Z9SZj3bHVUyj+JdYcruH8QJmEfxXYWPvIXOf9oxvfBcAA834p196bF3ZQQxPy8ELJi1pMzY16Nn5vmhCOxkPdIeH8/4W1kM/YCcBNOgNVc5s4HJVral2j44mU8EDtlYeNv16rS5I4xjPvdzA1ZbwXXQtN6Ovvc/foZAzenofTXT1e7Z/NTrxthUGGNaczzkoLN1I/2jGBbDzqiIR96ZdG2VaC4uaFHFgvVMBbGQUcEmOYotqYqS6XtH9p4bkMif2kf9YHQxdDgNNtN7MW///mvl1RuObus0USZjKXccpBxkvFi6aedXjsbMqvNdhp50f0avMkXY6OwWshlEW5d7HoU9hOJ9+/EOEvlUlpwUu2v30iZUSh9rFQYskSSFSpHcaD7K1cFKOYctaFmOepDToByF1eOX+bABBoWEgIIKgSTlqMtBe1zjLc+YO54mAKq3J3HhLvFKs8JuSnMITtXIDfPZCgZYBDHy00WAHQA4WF8sOPzuq5j7l7HYJpJ2Gsm786OT99fno5pz6atKG0cKHdSlVQ0pTTZRRTk43V4cPg6fhX/SHuJ62Bd157e9eppuK0bQrhTCv9/N/u/czcbWMbN+WXOQeubANqHUC8/R3evQs0DXN1QEWomvlPVxMd051Z2OrgXdZUTRSajUgyZDw9zbsRHnW829NgNrniOr3dcOy7w1RUyqbmLpguEQjyB2RcfwslfsievlPceuKluBZU2V4vwC19vqfgNr5xdyf0eu5593fwdtvbcvrneTvLOm37JsbdtfOUvyhoRX79ipoN7EUcOTZ3N7T3Rptt4Ecqwah4uuFdutI06IkfdHwg/usH/AI2LQjo=
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: eJztWN1uG7kVfhVigC4SQBp5neyN0bR1bO/W22zsjRWkRWBI1AylYTwaTkmOJ6qhu32SPlqfpN8hOZofyU5SoFfthS1phjy/3/kODx+iVJhEy9JKVUQn0Y3l2hpmM8F4ZTOlpeH0ii1zVcdsyu+Ef2v4WrCSa3xYoQ3j/vFPF1Omxd8rYeyIyYJxtlR6zUSRqFSkbKHSTczeCVvpAnsK9ufpL28gZiVYnQktsCWV9zKteG5YgvdkhCisTLgVrDKyWJEaqdnF+/NL9oHnubB4olW1ytiv7xipYUqzVIiS5bK4Y/dCyyXthxcxO13CWmdpq4mVWhgo8R4kWqSkERaM3ANnHR5KLZKwZqFVbUiOYvPmzazScs5qaTM2JyvmcC9lc2Nh+TxmH+DGUG+qEMxCWaw0NcTRZsTs+x/YWhaVFYcN8CqE1kq/kgXc4Qn5NqOwY0kKZVPsEkVaKrxnPElEiX2UGjLp+upmGkejqE1edPLxYYADknB5ztTSWaD0ihcBCdgpaUXJbYbvBWTgV3fFZYrnjTXRidWVGEUmycSaRycPkd2UtMNYjWxG2+2tXwzEvAY6aMVwb6LgZmHpFS/LPCRz8nlc1/WY8DWudB4gRov2dKnFJ4SOfNaqFNpKYfw6Ra+HJo0iUVRrBCXC60KmESxMxZJXuSVZ/tnoQMCcvCZmFHZjmmKItuSlKVVhxMyre1wtOdJX6p4cUkkiSGMjG8A3LnTQl+QSUZvJ9JCup9LtN3qTW3B/nZT37y6pLOpMJpkTtrOslnnOFogSZMfs0rJ1ZfCPWyxUxS5ujUqSZPoWMfEZWM83MZnmCuvLNp0WTJUcOWD3PK+IQ0BDMHDNURv4Y04O7LK1CBUaUuaKxSkHyyx4ckdaC1UkX6OV+RcDpdwYlUjSxxuXDEBC/OqqGoSHLFh1J4qRVw9DpZUr2qJFmfMN49bCFoPC6RbZxwDmIcq6KBikswnh7Xa77aDTVcbx0RF99J3a0TarxcKxkmcax08mAyW6cDUs3ITPsbDNuGVUOn5Nh70DNc53ds6ZNKwq7gpVIwrg8tq97/Psjjo9fngPNn3UdEi0NdLRpzOxUO1e69obwpwIYsgO71jx2U4yu84P8ssT9eAaXBDU2EW2RC7omeCpI+CH6K/jH4mPx1dut+nrAfDXZU6qzi/e/o2A2Nf0OlfAhHdyqdUaeCb0aTQBdNWUOrEzZEkq0JjDp1gvROpi7BmSiVysqROOsHXFdZoThQWrjSTcWivW0Ep9WCELzKjYu/Li6HgfMtNOOUkiwyWVgtNIIru9mdo9JdTQCSQASyt0SjTGb+q+tAQa9aZ7PPH9cj4KX2YdM/uNupf2fobeKG/p0xBoU5VZW5qTycTDMA4v4kStJw2l/LFp4+AJmc5CqL7bs/HV9c6V3x0fEXHiYyHwryok9nznrH/Fl0dy+cnk6d2nfYxMB+TaRssXQxutkNGXngQe6b6fzDASXTZyIs9813Lfzzu2oLU93Zjb3W2A6aizErobYRi4PSD+yaS85lQNZWVbf8nb7X5JYWHIxwCN/rRmdpRNBbFxR1tPVd0ekqk8NQTTQMprOhl6eeHQl/EGnWftqXHo07yV3D1pUU1RzSxVVaQE3RatPoEvvymBw6RYaV3MrhvPnVl7NHcRuNS5E8jiClSPVtbsjA+n+Oso1MOTesqIpgkWksnmg7Kh6kY0Zi4ac+KYOWgCHDPzxR81YJmlT6PlUN1wQ0NQ4C1vvAPNDlk7l6KdDdFBfdHbJmPRAdjtXnqQXOPIUKtAxG/UCkSOToQ2Stkn6BQCDoLugQ5R8EUOsm+s7CJlHxw/fGN144h2tXSTwn8TJtvRw07e6fVlE+nbg4HuZveRWF/SgFRg1vJr28ztBf7gyv+4UqVt+hmgE07CZacYurmAKVQZzeyE0UoZe3V5fnZauRHL8hWNaNEgWOzZL3R+RfZ4YZ8TqYLNMtUIcBMe9p9Ek/sXE3JKJmKyA89EyTSZPPTntu2Ee5U+BocGw3OxViFEWIe5q9PoUrwb81LGcqVhUyyVy2dfAMxPKzexPibmSxJuEBA6gDyy3fjXQ0NuyasExwS7uSFQexo6LeVfxKZDAtw/CEOuT1M75p76O5F/NJPw4NQPwN6JTffSwl06EIb8IBBgP+/JmTOvxg9ECwKKWMrPqGQ/6nsb2Zw9A56EE2A1l7mLQYmz6nOc5OJVPBB7wsLG329UpSkcYxj3h7mbnl4LroV2AIPvC/frR0zSnKbNnz9M933z46ybTdA6jWnM85KCzXTQ7BnBdhF0TEIx9Mqi3RmA8uamGVksVUNJmPNcpWNMo9yaqiyVtn9q87lLifypfdQHQhdDA292m9izf/32z+fURzm7qXE6MhlLueVg2STjxcqPMb1zaiiltpxplsWx1uBNvhwbhdVCrsAB7h7JbkZhP7Fz/3qJs1SupAXp1P4mi5QZhZ7GSoXpSSRZoXKwPl0FOXqnnHOQfs1yEH9OgHJ3QI5AFsAETiIkBBBUSCYtx3kTvM4xt/qEOfdwvK9y548J13RVnhNyU5hDdq7BXp6q0BNAGY54myoA6ADC4/hoL+Z1XcfcvY5BLZOw10zeXJ5dvL25GNOebdsy2jxQ7aQqqWj8aKqLKMjn6/jo+GX8Iv6e9hK5wbquPb2byotw8TWEcKfX/f+a83/nmjOwjBvgMdmD1rcBtA+hQX6M7l+Enge4umkhNEl8pzaJj5O9C07XKdFUMuq1kPHwsOBGvNf5dkuP3QSK5/h6z7Wrfd9NIYNOadHJEqEXT2D02bvg6XP25G3sQQebblZQK3O9B7/w9Y6a3fC2dnu7G3SdjX7RmbdkPPX3SI2QL9/AUsf2Ik5dTjqb22uUbfe8QrnCqkW4/127yS/qiBx1fyCoODT9G581wJg=
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: eJztWd1uG7kVfhVibtYG9OPNz43RLeo4aet2uzZiB75IAomaoSRuRuQsybHsCrrrk+yj9Un6HR6ONBrJiROgBQrkxrJmyHM+nvOdP2qVFcrnTldBW5OdZpeVMhevxbk1RuVBBPtJGaFMUVlt8HUug1D3+VyamfJCGiHrMLdOe0n7RW4LJabWCZnnytOCQkBalOIH4rzUClJoDz51zpu0F079VmunClF7bWbirzc3V+KV9DoXZ1grlhp/xnncPdLFWEiPlcoZuVBRR/POq9ypEN9X0vuldcVA3MyVGPt6MhZ3sqwV6/O2vIO+onakMMwTCOVDj9UBotAFwQwPYiFDPqeFMgSnJ3XA4XFKWpPLspzI/JOwU/4ekbDW5uhibsvCp9dSL7wYa+/HPYaFD1kX9FEBFzZHs9B3LeksdD51X+FB/NdYk6uxWMKEUeKuB9IhxFwWwhrFOJI3GAsJCW1wkA3bCzkNyomXYqENnW/wwWS9rJIONsYLn52+X3W4ko6YDm7dTJoEAzs1rahkmON/8hO+tVdcFHjeuD07Da5Wvcznc7WQ2ekqCw8V7fCB3JOt172u7ndG/1Y3HppqIE8wPM43sfc7cAaH8aSll272lWg+8mLY+ZUtHmhFd29uTQAyeiWrqkxUH973l8tlHwGy6NeuVIbipaBFe7rs5FfEH3nA2Uq5oJWntzMnQXNe08XVy5SpF/BTlijxz6h0REoyQC7UVNYlMB163zvgWxJPZo1KxURRACDsimxN5y9w3jyMEECHoOxLe/f2AoQDb3XO0QWyV9Z4hXgrS4gXxP2eWNSgbwy4tIoVxf2kXWjm/Vn7EOIt+4OgxfM8CdKuiHNKXlClNGWGqbOLz+lZtwnzvu2YjnESoI/rNe/hQ0dvPjs5oY9dYGccrEecO49TkDb7ske59aun7U+nEieFURT/NHP97fYmoYl1IEf6T14jx6YkAyUB6mBBSrK1w0NyStz3KHEf5x55gHUiY9aQevRKSafcMQnlzOVHun0A1Ck1U+6gVMTHhFMFKoU1yMk10kcZtZR2BmbBM578nESTFl18tZGieeAmqY3fVhFtKPKZR3Ji6xD1UiHL1syOuZJFzLWr7FzCj33U4eBsedCv27C/l4uqpEfG9n2wThHsXWgXpiCiKM/gduLPz21dFsJYCnK4FYqKQRYBvWCGPplyKDmX01gquuSDBSLEK2fvYBEnlHN230tv6ClqlF9uU3rqSZqdgIZy0Mg7u7pIoigtb0yxyvgh8QFlHz6MEUrWouejrnXimsb7GXtjd80rWTTVlatq1ZyE0frUpkT5Tdnu6hrz1vg8dkvokVB7xw3IpICKf218XVXWIZRG2+wS24K0mFuNpGrnmElNMuMc7RBDoRTXhva6hWzbUbRLJ3VLRIyprU1BdXRLUebHj1/Fj/8mK7oJLhHgKUG79Ucvtq+JRgf9AmuMojXG1AKOEb13yo3Y6zEp7fPrKRCckrBW1B4aRByDn+E0M+ALpP5hp4L9INiDgnNRdoDp70zTIKimfd4RMW5EFFYxO5DDImru2aO71S5Zstvb2/7ZtvFXT01pLBLWKRc/feiOJ43zP2T7Ge8m9catSYOBbTPgZq6h2lUFv0l6L76T+n9P6g2GR/j8S5OGDnF285IJe5Wmv5Jakp9jZVf38Gas7ZQPjcIBUe7idCsnJXV8CeVjE8Ru5nv5/18Zm9F11Cg8ZPXIJJgOw3YpiBc6J7+G2hnY7OXJ84PFsjtzo1dM7UUzeg/ELU/1CQTa+/GWJO3auIE5lRp+IrruIm/XxKapSVVuga4R5BwRlEZj04/9Iw31Z5uZvguAit9etAzEJVYhfwJNDXVihnmhEzLfXH51aEyF0EkTUNVKBm0OwujoYjFihIfIq5gpKcXi20dyOeWNZtjG7Gt9uLx4fX5Dvew1c5zYJ2c022cdKomj6wNhcExz5EKhFjQS4x0BqcyGd8+HiR/DTawNrS7y4Wp38l8PV+3Rez3k9pqOQzY8dNXwWi2s4NdYh9kZz+YhVP50OCzwri8rPdCx9xlom+3fF+BcRZ1zFTgs5ksSrmEpmoAf2e75dRfIx62TrmP1iVn8rNJ/Vw+tHCr5QbqmYC9vLyp2qu9eYqA4/6QeOsWOKcjRl7LFI1U8DtwT4pma6nsENfexjFGMxRHoyOU9OHA+2qCSuTruCTWYDTpiT0Xa+IcHTH9kjj7A/XFMuSnj2Y05usom8dufuQ85zTA57Z+tfXNFV3oNPJaUMNOVwO6YvrEgl3xIYmVEeLY4+S1O8TSVNZlc5jGTI2Vr8m1qwP+09efGJfov20e7RGhzqHOazSZx9O9//X5M6UWK66UqtJ+LQga5uVuNSQI009NN75JS7yYbiIvYd3m8Kad9b7Fa6ZnZjJu9tJ+Km8idio9l6XvQWeiZDsjnS+RRFaIyZGX0ipUtBMb3ubE0DissjtUxXn2iZi5FibpZEqFozI6diZyAE5huSQgoaGnAxfLcotxoaXLFDovHc2pWl/E8nnwmxbQuS2JuATiEc4Hkx5kOpVTRfQfc0URBRZOpeDY42bP5crkcyPh6gFQzTHv98OeL8ze/XL/p0571ttJu/UCxU9i8XjTXrhBNKYj99ezk2YvB88GPtJeSHdC18MREKt6kHrJL3VZr8P1S/fulevtSPWWggCo5rADdEL8ioVepmL7P7p6neggqx3koFVT8TyUVH6d71+mnnQttLquoQHMq1BC6Wk2kV+9cuV7TYxzKUeuAf++ki4mCSy+EUkecnU6RL9RniH30NnHsWHz2x4CDJ25Kn6G6F1mEb/j3E1XG7o8FsR5/C66v/qHgG7Du2H39cXORF63JS84ZW/+Gb4gbEV/+cYAOziLO4pD6yOY4cKzb3dnV5TXV00n6hWIRb8WzluRe+wu1jOv1fwDSsPjZ
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: eJztWNtuI7kR/RWiX9YGdPHO5cXYDeLxTBInu2tj7IEfZgyJ6qYk7rTIDsm27Ah6y5fsp+VLcqrIllotecYbIAECzIvl7iarilWnTlVxlRXK505XQVuTnWaXlTIXb8W5NUblQQT7WRmhTFFZbfA4l0Goh3wuzUx5IY2QdZhbp72k/SK3hRJT64TMc+VpQSEgjaX4gTgvtYIU2oNfncdN2gun/l5rpwpRe21m4i83N1fijfQ6F2dYK5Yaf8Y57x7pYiykx0rljFwo1tF88yp3KvD3Snq/tK4YiJu5EmNfT8biXpa1ivq8Le+hr6gdKQzzZITyoRfVwUShCzIzPIqFDPmcFsoQnJ7UAYfHKWlNLstyIvPPwk7jM1sStTZHF3NbFj59lnrhxVh7P+5Fs/Aj64J+KtiFzewWetaSzkLnUw8VXvC/xppcjcUSLmSJuxFIhxBzWQhrVLQjRSPaQkJC2zjIhu+FnAblxGux0IbON/hksl5WSQcf44PPTj+uOlhJR0wHt24mTTIDOzWtqGSY43+KE57aKy4KvG/Cnp0GV6te5vO5WsjsdJWFx4p2+EDhydbru7gYJ3tji0da0d2bWxPgO/okq6pM4Bo+9JfLZR+QXPRrVypDCC1o0Z4uO/kViKczO1spF7Ty9HXmJIAV13Tt6mXK1At4JktB+AcrHZGSDCYXairrEjYd+t474E0ST/5kpWKiCHIAepGt6fwFzpuHESB7yJR9aR/eXyDEQIrOI54Br8oar4DwsoR4QWjriUUNwDDE06qoiPeTdqEj0s7ahxDvYzzIND7Ps0zaFXFOdAFVSlMuTp1dfEnPug2Yj+3AdJyTDLpbr+OeeGiO5ouTE/rZNewspsdRZKvjlBbNvuxJbP3qafvzoRTTcMTin+euv97eJGuYeXMQbooaBTalNZQEqIMHidZqh5cUFN73JHCfxh5FIOoER9WQevRGSafcMQmNXOFHun0AVAY1U+6gVOTHBLQCueBma8CCNSi1ZC2lnQFZiIynOCfRpEUXv9tJ7B6ESWrjt7ytDWV+xJGc2DqwXiod2TqiY65kwey2ys4l4thH5QvOlgfjuk37B7moSnplbN8H6xSZvWvahSkIKMpH43byz89tXRbCWEpyhBWKikHGBr2KCH025EDyl1Mm5y744AE28crZe3jECeWc3Y/SO3qLquCXMU5kaOoCmp0wrbfayDu7ukiiiJY3rlhl8SXhAYUWMeQMJW/R+1HXO7ymiX4Wo7G75o0smnoW61jVnCRa61NjwPKbQtnVNY5b+T33J+hKUO3GjZFJAZXb2vi6qqxDKo227MKFOC2OxT2p2jlmUpPcOEcDEk0himub9rZl2baGtysj9ScEjKmtDUDRhmjEx/e/Cx//TVR0CS4B4DlJu41HjxvGBKODcYE3RuyNMTVdY2TvvXKjGHUmpX18PccEpyS8xdpDY1HMwS9gOiLgK6D+bqeCfSdiBEXkouwA0j+YpkFQTcO6I2LciCisiugAh7HVsUvmcKtdsGS3t7f9s22rrZ5LaVEkvFMufvzUHQia4H/K9hnvJnWjrd4+GrZlwM0kQbWrCn5Deq++gfp/D+qNDU/g+ZeGhg5hdvMxAvYqzVsltSQ/cWVXD4gm13biQ6NwQJQ7niflpKSOL1nZpr99xnv9/18RmyFx1Cg85G1GEFyGsbYUhAedUzxD7Qx89frk5cEi2Z1u0SOmtqIZcgfiNs7PyQi09eMtONo1cWPmVGrEh2C6a3m7FjbNTKpuC3SLAOWITGk0Nn3Yz2l8PttMz10DqOjtZclAXGIVeBPW1FAnZpgTOqnyH5ddHRpXIWXS5FO1SKCNQTgd3StGi/DIuGKGJGrF0x2FnPiiGWsx9VofLi/ent9wDwvYyRmNz1kHQ+LoZ0mTFbLBhGOaFzFpz20jgadvUpEN718OEx6Gm5waWl3kw9XuTL0ehqQzOunQ1P5WLayIn7EOQzHezUOo/OlwWOBbX1Z6oLmpGWjLON8VAPuLOo/0fljM1yRcwyM02j6x3cfPXUPutlG45rLC9HxW6b+pxxY5yvgi3UDEMG7vIHbK6l7mUyJ/Vo+dKhYxFtMr0cET5Zkn6QkBSU31A7I2NqjRRjEWR8BbrNvBAdTsg0rm6rgn1GA26Ig9FWnjD48Y68gdfRj3hzGRTxaHsgjCVTbhpz/FBuM0w0i0f7b2JRDdjjXmRUnJZpr1d+fvjQdjLYekqIyAHT1OcePxnMathqplzlQNTtYU29RZ/3Ebz01I9J+3r3aB0MZQ5zSbTeLoX//87Zj4Q4rrpSq0n4tCBrm5pmQWAMz0dNOUJG7dpLu44IbK40s57XuL1UrPzGaO7KX9VLVE7hS/lqXvQWehZzqAsJcgShVYGWgXTWBlC+R2PjeW5lyFxVz2+BYRxXApShTEkgBF8zO3HHICTGBsJSGAoKXJFctzi3qipclVDBgfz6lZXfJ5PMVMimldloTcAuaQnQuwW6Qy1EpFFxkIR5MFFY2c4sXgZM/ny+VyIPnzANwyTHv98KeL83e/XL/r0571tpRu40C5U9i8XjQ3mBBNFBTj9eLkxavBy8H3tJfYDda17GGmFO9Sc9iFbqv2f7uf/nY/3b6fTgwUUBaHFUw3hC8G9CpVz4/Z/ctUDwFlHnRSBcX/VEPxc7p3Mx3LKCrOnCoxhKxWE+nVB1eu1/Qah3DUC+Dfe+mYGGKphRBqbbPTKfhBfQHIR+8Tpo7FF+/RD56wKXWG6hyjBk/49zNVwu49+/puc8/FNsZF59GS/k28QG2EfP3unMp5FHHGM9wTm7kvX7ebmqvLa6pKk3SBv+BL46wludd+oM5qvf436fp3Rg==
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: eJydVl9v2zYQ/yoEnxLAllJnT0FRLFuzwtswFHOGPhQBcpbOEhuaVEnKriv4bZ9kH22fpHeULEvOn2H1g82QvOPv7n73uzQyR585VQVljbySfyLk4jrLbG2CmJuVdWvgI95D78XZ7eLV7Fzgl4DGs8lEOvSVNR69vGrk7OKCf/6f095b556cZtbQXmBfUFVaZdEg/eTZYSN9VuIaeBV2FdITdvkJs0CGlbMVuqBaOL3nRYBQ+4HB0lqNwPjHWOcm58fQi22JoUQn6GuAUBFcA0uNudwTTIc5wVSgn8Iy9vxCAtRgq0/BOJKK0kwvxTtvcaWM4tU8H7zrg1OmePTu+4GlOJqKeUS+UhSiXcUoX0A4CHRPH67651rRprz6+CjLo7zc7VsDj1ntVNiRQSOvK/Ub8vJuP2nkTwgO3XUdyrhzN5EBCs+en0ck6daaCmQJgSwwlh7YgUw3lynRZ6WKtAeWQutoOsj0FFpHDM1t0PmIbJy7t7i2oj2me7WjMssyhMpfpWlOZ1OoVKIKByYkykoO5jT5Nq+ziPsZN//lgXJaUFmfM/ft8SmQu2PCF9wrLYkOae8pA+3GRCp+qqQ+jU8YWPMpV8Q69TWm6zGf38/FA+4E0C2udduiibglJm1A13ig1f3Iz71onxHr2gexREHMXqkvmIutCiVdjpDEvTgzNmB0EBwoHXNQQYbnE4FJkZy4vRKd4eudrR2nY0rg3twn3KZDgjVyGf/6JfKA4vj1w+1TvcqsD/YBjajA+wO81lOHmfpWjECIPoNRoKLORAPa6TLOdZPcD8xERsNKB1lUOpI0xbX1dVVZF3481rMviXp33BoTYcihk2h6I3H279//nLOGgVhsMVe+FDkEIH3LSjAFCjC5IJqRLLTljLRTGVfJbhTFloh5EDWpPZ3o1dRbuo2qIGGMDR92k86eNXIgG35Cb+aqUAG02ILWGOJj3mqVi8rmImBWGqttQYo3aUWWaw7C4FZo3KBmQimaC1EYYUmcCLvohChouanpembXNC7AEORYsBiew6LWMR7WWnK5qrVm5uYEh3GuwRiKjZJKo4YkA7kchy4g0hEJZ8nFo5xvt9sE4nFiXZF2tj79ff7zzR+LmynbUDUoLXpUPMG9k9usXh+EmVyzBLX1ml3Mfkguk1dsW1kfCN0Az3dM0xEdmuNw/Z5x3/E40F5aaSDh2HdpaToF/ig3l+0IJw2mxdD6BR0mySopWLZvmiV4/Mvp/Z63P9fo4rCgJIGLzGpHx0GxWLgfWNhi41Y8DKICRYU7+e9hPxwc726496EThqMoPkRR7Bbs/XBkdgPfp/rYQuBvlvEnTV5z5Umm3vTX25NnDXpFaW9zunmifgMRU2Sp
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: eJydVsFu20YQ/ZUBTwkgka7dkxEEcW03VRsUQZ00h8CARuSI3JjcZXaXUlRBt35JPy1f0pklJZGUjbS5SOTuzsybmTdvuY0ycqlVtVdGR5fRH4QZXOUEK7JqqVKUdVgrXwA1mYI1liV5oC+etBOTSWTJ1UY7ctHlNjo/O5O/odPb9zcz+DCyhNTopcobG0KwH37nLS/mWNdlFzv55MTHNnJpQRXKk9/UxF7N4hOlng1ra2qyXrUIDgHuPPrG9QwWxpSEEmoIb6YzCUYO1gX5gizwzxNFeDwV5YA0LkrKop3gIceJBKsbWiqt5GmW9aA4b5XOGcnS2Ao556hpVHaC7G3PExxdgcp4lZGRlXjtm99cWwpPWPazRmtxc+L5jXIezBJcU9fGespg7wXSnht27qly/6HqXfrfW+1j0FEx1aNlG7q87hkPKqOxom+b/9JUqKeWmS9R+1CC/W4nHP/cKCv5fTykGrB1Me53J6dGNHy8TWInlo7SxvIeW26jq1r9RvJ4v5tso58ILdmrxhdh5X4SecydhBCG/tljaMR7FZfUMIAop9AkFLMoWV0k7bglB1wJ5jTtEzwSGJZXXEAxrNENVQbabT7X2JLXCu9rd5kkGe9NsVaxyi1qHysTCfAxlU3WpIG9T7j5lgcuZM7te8rctdtjIPfH4t6JgrR03Zf4OCXtAndJQhXMhRCiJVAk1TdW/bWv0xDY1dsZPNAGkE9JY9tyxvCOeb3CsiEZNCH5fOBnDm0YqBqexQUB68ZSfeFRDEozbzHCHJ5p4yk48BZVGWpQY0rPJ0BxHo/cXkJn+GJjGivlmDK4l/NYBqJPpm20CG8/7yXo1w/vTnNLU3IOvHkgDTU6t4fXeuowg9IwAAGHCgbZDnoQDHilq7j0LcyW0ksjaET/MQ36z0KvpLedOr069vPQEvX6uDQkQp9Do2wORvDs69//PBepQbhbU6ZcARl6ZE1PC9Q8WKizofwL7VQqXTIrHmUbw8xDw9ce75TLqTN8mlSuD0I66exHouImHDNTufIsMN11KsGcKVUGtcnAU1poU5qctXXSaqH0HEHTGkpaUSmEUnxbBgnGBXOCdVucMAUNN1OOp6biSxQ1Qw4NC+lZypsy5OOkZwjLpiyFuRnDEZyshJpz46LyBcxCEeRzPwVMOibheXx2UvP1eh1j2I6NzZPO1iVvZte3v9/dTsWGu8FlKQfNA5mdzKRNtb/m2LVIUNuv87PzH+OL+IdwqxrnGV0PT/hWwf/1rTKgw/b4yfE93z0djz2vJXWJLBy7rizbTnc/RquL9sOGlZcf+tYn6stCVXCKYrXdLtDRe1vudrL8uSEbrgMuDdrAp/Zy2OuUyPWDyFkY11qEP+hO0LXRl9Suf0m8vpWJx04OjlL4EKSwexDv+y296fkeq2ILQX5FvB81eSH9ZnF6eTje7jxpcNCR9rQUWe7MfwE5v8Eb
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: eJylVttuGzcQ/ZUBnxJAXrl2n4QgqFu7gdqicKsEeQgMeLQ72mVMkWuSK0UV9NYv6aflSzLDvejiGEVTPUi7JGfmcObMGW1VQSH3uo7aWTVRfxIWULi8WZKNEHRptS1hrWMF1BQa1mgMRaBPkWwQk5HyFGpnAwU12aqL83P5+d9Oc2f5JYovrGujcxRf449BHG5VyCtaojzFTU0cws0/Uh7ZsPauJh91C2dwOYsYm3BgMHfOEEqoY6xTW0gwCrCuKFbkgb/g5t31FN6fwAQdgCzODRVqJ5EpMOQE9JoW2mp5mhYHQUP0fHOOuXB+iXw71TS6eILh9sAT7F2BLnhVLzR5iffYoJGX4sbw1b2zOp9xavmenm69W/Fp/7XYx7H+6L3A3g0MfqB3BBaXJFH7Ms6i81j+h0DXQ/1bS6iPXe+ESY+N9pzNyYcnlbvbyWekAuWN13HDZ7bqqta/kjze7UZb9SOhJ3/VxCqt3I1UxDKIsyH2rOWe4r0lV9dxKFVS4g2KmRqvLsfMvYUuxwOCcX/ns466SmD4FfmQUJzck5YO2m0+13jDa1WMdZiMxwXvnWGtM116tDHTTgnw0+q7oslTwZ9x828eOGWldNgz5qHdPgVyt0/uTNqr7aA+xUN5sV0YKS2hKm7tFCIVcaIk+87rvxJ3n3Dg6nYKD7QB5FNC5barM3jLLbZC0xC4Req3+yM/99CGgWUTIsyFOtwUn5izSUPuW4xwDy+si5QcRI/apBzUmNPLEVBWZiduJ9AZvtq4xks6zhjc6/tMeH5Ipq2ap7ef+6795f3bp3fLcwoBonsgCzWG0MNrPXWYQVs4AgFDBpOmJWlKBrzSZVzqlvpD24UTNCKOmCdxZBXUUtvQ1LXz8Yd9PYeS6Df7pWMiHHLo5DaDEbz4/Pc/L0XqEGZrKnSooMCILIN5hZb7GG0BTDMWkbaciXY63zd4BtMIDQ8I3jGLs+D4NHEndXoWN6POXqQUchYAWUYTRhyz0KWOaPoZIcGCM7qA2hUQKa+sM65kuR+1Wiw1R7C0BkMrMkIozaMkTQWcMyfiJjlhCjouphzP3ZInDFqGnAqWruepbEy6T5CaISwaY4S5BcMRnEu0lu/GSeXpxEJBUo6+C5h0TMKL7PxJztfrdYZpO3O+HHe2Yfzb9Keb32c3Z2LD1eC0mKPigfROL0R9d4kEtfW6OL/4PrvMvkuDyIXI6A7wfMMAPqLDdj+Pv8VXx+PIa+PaIAvHrkvLttPdD2p12U59Vl5+OEJyqr4sVBVfUay22zkGeufNbifLjw35NA44NegTn9rh0OuUyPWDyFlq11qEP+lO0rWTvxm7wyHx5kY6Hjs52EvhQ5LC7kG891t2c+D7VBVbCPIt4v1Vk1dSbxan18PxdudZg0FH2tOSZJmZXwCSn3mM
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: eJydVlFv2zYQ/isHPbWAI2XJnoKiWOZknZdiKJYGRVEEMC2dJdYSqZKUXU/w237Jftp+ye5I2ZbkZC32YlMk7+67u48f2UYZ2tTI2kmtoqvoDxQZ3H2cwka6ArDJJGxEWaID/OpQWd41iQzaWiuLNrpqo4vzc/4b+nmoM+Ewg9uHmxl8GHnwAVKtljJvjHDBJ33TsmNXoq5LmfqF5LNlf21k0wIrwSO3rZEi6MVnTB0Z1kbXaJwMaA5B7p1wje0ZLLQuUXCoIdSZyjgYWtgU6Ao0QD/PAJcWUIlFiVm048hoCbIHeoNLqSSPZlkvqHVGqpxiLrWpBGUXNY3MTjC863mCoyuQGc3KpUTD8cKX204N+pEo+/kJY8T2xPNbaR3oJdimrrXhluy9QNpzQ84dVvY76tul/3/regw6KqZ8smxDl9Oe8aAySlT4bfNfm0qoM0MU56h9KN5+t2Nmf2mk4fw+HVL12LoYj7uTXSPCPd0mtmNLi2ljaI0s2+i6lnfIw8fdpI1+RmHQXDeu8DOPk8iJ3HKIO6U38FE3BqaNdbqinGm1oqJqghDl6Nsk2DBK1pdJOFrJAVmy2qYRxzZrNNaHHhbmBisNYZn2NaakucK52l4lSUZrZ6KWscyNUC6WOmK0Y/7qrEk9ZZ9x8y0PVL2cevacuQ3LYyCPx4res0AEju7rejwaYYJaw6EKIoAPEVgTccm1kX/ulWgI7PrdDFa4BUG7uJtBl2J4T2Rei7JBPl3M7PnAzxxCGKioZbBAILFYyq90/ryyzgNGmMMLpR16B84IWfoa1CLFlxPAOI9Hbq+gM3y1JT5wOc4I3Ot5zKegz6A2WvivX/a689uH96e5pSlaC06vUEEtrN3DC546zCAVDEDAoYJelb0IeAOa6SrOffMHSqqlZjQs7yL18k46Lrm3nST9dOznoSXyzXFqSIQ+h0bZHIzgxT9//f2S9UXA/QYzaQug60iQkKeFUDmCUBkQzUg/Qjs97WTKXdJrOr8mhpmDhm44WimXZ1bTbpS5OqjnpLMfKYmdUMxM5tKRqnQ3JwezupQZ1DoDh2mhdKlzEtRJEEDuuQCFGyhxjSUTStJl6HVXLIgTJNbshCioqZm8PdUV3ZFCEWTfMJ+ewbwpfT6WeyZg2ZQlMzcjOIyT5E9RblRUul9JG7xm7k8BkY5IeBGfn9R8s9nEwi/H2uRJZ2uTt7Pp7e/3t2dsQ92gspSD5gGfnUynTbW/28g1S1Do18X5xY/xZfyDv0q1dYSuh8e/REi4/vslMmBAe3xEfOdDpmOro7mkLgXJw65Lvu0E9VO0vgyvE5JUGvStWVZJgQrCzhvbdiEsPphyt+PpLw0aL+6UszCeKEHq9wLEOrxinfLnsGYR94LiBWv0Atr1Bf/NLR9l0Z3zo8atvMZ1A/a+X1Lbnu+x3AUI/Muq/KTJK24kqc7rw/aw8qzBQSDCbq4r34D/AlJ9o+Y=
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: eJztWVtvI7cV/ivEvHQX0MXedRpACII6thuo3XS3dox92BoeakhJjEfkhORYVgW95Zfkp/WX9Dvk3HTzOhsUfWj9YM8MDw/P5Ts3ep0I6TKrCq+MTkbJtfRWyUfpmJCeq9wxM2Vcs/eF1ONLdmG0lplnWa6k9gP241xWz0xqPsmxr+DOLY0VeHYsNzOl2VL5Obu6vRyzjzzPpWeTFbPy51I6r/SMPUqrpirjJIJjU2sWTGmhHpUoee62DsmMnqpZaQMtqLK8FHSmlQ7L8auQU6VVePRz7pkrZAb+IFvOVTZnmZUCxAq8mTe1IKzPeFFIbkki7hhnf7/GcUIyY8FSFixX+oEFppLxEr/BIwoNnWcyysm1W0rL5iYXjqVR6huJI32KNYFPsMCEZw/1R5gny3Es8/LJD5JeUnDLF9JL65LRp/WOe+gIuAE+8Y1RsEfRWsH9HM8au/EW18YCX0hDBaWTkbel7CUum8sFT0brxK8KonWetE42mzsidgXcIB2tvzk5oT/bMlxEV1T4AH84xZMcoIQJ88oow58cka/3jzOTn4AhUtWaQlqv4mGVNp+l6zr7svE1NN1TqPcC6/3BNaCS4hiQBuz8KMYmMjd6FqAEsC0MoGR0zX2QbGqPvEQ4otxxLvY3rvwiBVsOEXIv4+IC7T4nGAlQyvzt9dh1OHFr+YqA6OXCHUDWoSMeea4Eqxky4simCLb2wBhSaU1yX1qVVvmIAtBY5aI76hhelPSLe0Q5+SBKv2DyiWc+XwVnIPzMUor3ViEz/V4VlnKC9BA40WErU1rWCYFwYB3w0O9lpgchISkmK85SV05SMlaJ81SeA3AMPLMy5x6IpaQCT5VW00uWIfNSBgMafXAjIrWL3AG7WhR+Be5SdyzNSkQ8S1VIjH71A5kQbM49xJyUXrp08A/d1eYLsIQjRIiSLKPSQIenHeOkA3ZdJaoo3dYiUw58Yjwdl/JQ8uBChEDl+YetNPIZ954DRwU5tS0XLB6MUmJDuGc5VwtGaddF5VA2qEiEmkb+iniuxY3AxCJ8wOHaB7lqOVLBaU8aRes8Zr7G+81l/y8ff+yQ9CKJMBkpUpMt8L5FhPMBoUgSMUSE7OPbiw5ZjLO4rKJnhPF9J6kWEchIxxpSUWsq6aoqsIcZheCj1UA/kZlZyMrrhOjngbiFCyCvlyCGF0Ue8iiwPpKlUKNCidEpfIXyonKUr17iLQowgp1KA/f8PIve3Efpgj+9k3qGijk6PTs5hFqqx1GDuDappI8tTWUMSGuZigp0GpxecHwlMkvfmRmLe0KGMBookWzC0U9QxJba75vjWLmZA2Qah7eKMgFNd4yUfP5IgvyD+vKqCfgSC7dySJg/cI0WqMtsYgzaGr3HbYzODtkxdGMSDLv5PgR54NdfRIaEX2081d+dhboh5BrrlBPLQgSshnYNPpAiJIvq83k3Vyn0KzNpD2rqVVuCc45yEhlsq9+LHeKtVk9hg/OwO9kbqc5o4bquOP367OuT06/QSlH6tPKLpQl7yd+/U5TTP0KU+NNL5pKL0GqukwskJdlHh++tyQ82bg1AWpxp03feWLmfQFtHhyAiievekrm5KXPBKs9ldDB5iwQ6iy3ni3vKtrn9lEhrjb1Az04i0vNlRyL0ts/3le3uQ75pVD4Ljtxj/6yVvuMCLilK1OK6u08qB2wbjQirZibm0g/daepdSD3IS1K7MP+4YMI4eQkaHlp3Rlue/g/b8lZXTeI/pThgmrPfZJpddVHQgzToKTCnIosFJfZi+Iq+1kNhFbfVKF3vHBw23svyciANY+pOyVE6tNf3FZjSHksBlfspMr9IKUemqFwYvO8DhzSp3XAvnvfDvgjISrBW07lH4YM7OiW7UilpZEgOnlfPloTqSHbAr3s0u7796jemEIwK76dh2P5PennTWzf8zj+Ma0PdHbRT1zlHTDWGdhZdLYu0reEPZOIDlNvXFaghaROz1U3FblimsTlRTdGF59HGxmalxXLXF9QfyAxjm18F+54X6q+SHu/IGt9JbqU9L6kJwxdKKnxGtx7Jzm1T9DhlHYT73CA/JTMZkg5deYyS4ePbYRzih01yHBolsmGskcN1PUJvkl5l20O3K5dyYSojga60qILJ3PvCjYZDgbU+L9RAzdB6+YEywaPbDOBtUcam7Aibz3G4gQlofjiy3cXlXUHuWjvfEKxjHqmt3Y648UN1XxQd1d4YnVfZMoTJHsYJsjSxbN987TX8SD1bfFIWj4mj+ST0tVP1RDMeXQqmUUaWsldAlAwM0NqqPNig4Jl83WNygJFpm+2IVRu/ofaWzNGHcN+moeXr4mqdTMLbn43F+AU9MEXt61ZNpOZB6nB/WYsXOVUyU1O1JQRrLBhySeh6w4akKY/ktzCYKD01dVJC2x5iPUwtiPWyKIz1f2r92bhEfd9+2gZCF0M72jSb2Kt//fLra+oSOLtZSqHcPMwKqBLZnOuZDHHevX0NsFNZJ6DZuBrJnMynfWdALdVMN0Ntr9pPHUj3ZhVtKRNqpjzSzjJe+tJhztCdT2EExqtsrg0NUxLEoYUJN69MyyXL5aPMCVDUM4TayCfABOYjYgIIGjiTyDFUIrNzncnosKCelTO6HAm3yfAZZ9Myzwm5AuKQnJghdExWqApIFyH11lFQUDfK3gxO9my+XC4HPCwPjJ0Nq71u+G58cfW3m6s+7dm0RaP1A8UOBvNyUQ90YE0pKPrrzcmbs8HbwSntLYzzkK4jzzUwxt6PLy/qLLjj7k6d+//l/X/98r4Ke3odFjlX4c4soGhdFatPyePbeGcOW4TGtipYeKaSldS3tXgYNTe/SPBzQIO2r9cT7uStzTcb+gz9baiogBT0JzfGyqZcmAqS0RS2ks+g5lV97faaHfn3wkGt6pqiqaCECoA3PNK9QOffD5u7ZsoMcsVlyriF72zc69A23Wr//RUlbV5l9LaaPYRqVj10GrhtoXYLWxQh3l8c2fINhSzqy7cNeVw5uqEpBZGaTHSH/uffwxCiKQ==
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: eJztVsFu20YQ/ZXBnmxAohy5JyMI6iRu4DYojNpFDoEBj8gRuRG1y+wupSiCbv2Sflq/pDNLSqRkuUbb9NaLRHJ3Zt68mX2za5WRT52ugrZGXahfCDO4wdWcTIDLOhTWaY+yCEM4mVoHr9HM/Cnc3b4YA30JZLxYDpQjX1njyauLtRqfncnft/KdWsMvQVxiVZU6jVajT178rpVPC5qjPIVVRRzJTj5RGtiwcrYiF3SDaufyNmCofc9gYm1JKKH2IV+bTIKRh2VBoSAH/NNBA+2BDE5KytSGozW5vXGU8Z/G0h/DtB/hjv0d5+SGGeWvzctbmmqj5dE/SmsbFl3WhX6eDZ319vjgtMkfoftbyOA6xp5qcsKGwTl96wjvcUKlON+y/nwJP/QKdzxYR9pePTfS059r7STMxyadLvB9V+/LNLV1v+z/c/9fc7853HF4tI8exmjHhp7S2umwYsO1uqz0TySPXNG1ek3oyAnG+OV+oALmXiIcx9+TLcWb55yvZUAqp1h0FD9qtDgfsYRNdT7a4Ry1+IbY9zfU3tdcQsHoFuR8hLhP6luaW2iWeV/tuN1UEULlL0ajjNeGWOlE5w5NSLRVktVB2Z3N6jTCf8LNcx6Y5Jwb6ilz3ywfArnvmL8VxW6Owpb/XTNh82GgtIQqeGjEEE1Lq5b+r5GuRw13eXMNM1qBkCpVbwZFAqKyCyxrAjuN3fiw5+cBmjAwr32ACUHluO+/UAZLHQreHCHBA5wYGyg6CA51GTmoMKXTAVCSJwduL6A1fLmytRM6hgzu1UMip6jfaWs1iW8/WDdHHnPqxw93j3NLU/Iegp2RgQq938JrPLWYQRvYAwE7BuOYjMc1GvCXlnGpWzxz2kytoJF5i2mctzxYtdTW11VlXfi+q+euJPpd92m/Efo9dJDNzghO/vjt91M5/Qi3S8q0LyDDgDxl0wJNToAmA24zFremnLHtdCpVsgvNuSVwHaDmqwevlNOht7ybdM7jOR79sBq09iIfkHaKMOCYmc51YPlZYllSiMG8LXUGlc0gUFoYW9qcdXvQyJPUHMHQEkpaUCkNpfl2EuUdJ9wTYRWdcAtaLqZsT+2cLy1oGHIsWEzPUV6XMR8vNUOY1mUpnZsxHME5R2M4NyaVLzwsGlHQt6eAm46bcJycPeJ8uVwmGJcT6/JRa+tH76/fXP18ezUUG64G01LuFQ/k7GQ2redb8WfXIkFNvcZn4++S8+RFvOdYHxhdD88/v9rtdcW6u+n9C5dtVwf+NqpKZBnZtCStW0X+qBbnzbWSNVkGS8/6L3WZJazg5MXDej1BT7+6crORz595OU4RJg1d7LRmpmwVTIR8JkIXD3Il4yEqUlS8gzvtpj9K3l2JFmArFJ1IzqJItg/ifbtkVj3fh3rZQJBfkfWjJi+lE1i2Xu22NytPGuwUptkthMuo/RODJVhP
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: eJztVs1u20YQfpXBnmxAIh25JyMI6iZuoDYtjMpFDoEBr8gRuTG5y+wupSiEbn2SPlqfpDNLSqR+DLdIeutFIrk7M998M/vNNiJFl1hVeWW0uBK/oUzhVq5L1B6ua58bq5zkRThbGAu/oE1yqb07h7vZiwngZ4/ase1IWHSV0Q6duGrE5OKC/76d98RoevHsVFZVoZJgF3907LkRLsmxlPzk1xVSLDP/iIknw8qaCq1XLa6dy5mXvnYDg7kxBUoOtQ96qlMOhg5WOfocLdBPDw2UA9RyXmAqNhStze61xZT+lCzcKUz7Ee7I32lWbolT+tq+vMGF0oof3VFa27DSpn3o59lQ6WCP81bp7Ajdv0IG0xB7odAyG1qW+K0jvJNzLNj5lvXnS/h+ULjTwXrS9uq54a7+VCvLYT606fSB7/t6XyeJqYdl/5/7/5r7zeGOw6N98jAGOzJ0mNRW+TUZNuK6Uj8jP1JFG/EDSouWMYYv9yPhZeY4wj+SLkEGJeVsCJTIMBResi8RLy9jkrGFyuId1rjDOJZDn+OycycYqV2idQHoPrVvsDTQLtO+2lLTidz7yl3FcUprY1mpSGWW/ETKCM7toPjWpHUSknjCzXMeiOqM2uopc9cuHwK57/mfsW63B2JbhV1LyfbDSCgOldPwCCHaxhZdEb4Ewo7a7vp2Co+4BqaVa9+OiwhYa5eyqBHMIvTkw56fB2jDQFk7D3OEylL3f8YUVsrntDlAggc408ZjcOCtVEXgoJIJno8Aoyw6cHsFneHLtakt0zEmcK8eIj5Lw35rxDy8/WhsKWnYiZ/e3x3nliToHHjziBoq6dwWXuupwwxKwx4I2DEYhmU4tMGAvnSMc93CyVN6YRgNT12ZhKlL41VxbV1dVcb67/t67kqi3vaf9hth2EMH2eyM4OyvP/48Zw2QMFthqlwOqfSSZi2fhQxB6hSozUji2nKGtlMJV8ksFeUWwdRDTVcQWikWY2doN6qMhnQQAL8edfYsIpD0ujCimKnKlCcRWsmiQB+COVOoFCqTgsck16YwGan3qBUprrkEjSsocIkFN5SiO0oQeTmnnvDr4IRa0FAxeXtiSrq6SE2QQ8FCehazugj5OK6ZhEVdFNy5KcFhnKXUmnIjUunaQ7IRZH17CqjpqAkn0cUR56vVKpJhOTI2iztbF7+bvr75dXYzZhuqBtFS7BUP+OykJqnL7Qgg1yxBbb0mF5PvosvoRbjtGOcJ3QDP11zx9vqi6W98X+W062xP3+KqkCQlm46optPlD2J52V4wSZl5xAysn1FnErKcKGAfTTOXDn+3xWbDnz/VaMNEIeqkDf3WzpetjrGcP7LcheNcsdIHXQq6d3C/3QxHytsbVgTZyUUvlY9BKrsH9r5d0uuB70PVbCHwL4v7SZOX3A8kXq9229uVJw12OtPuZsp57P4NhLthFw==
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: eJztVttuGzcQ/ZUBn2xAWjlyn4wgiJO4gdqgCCoHeQgMeLQ72mW8IjckV4oi6K1f0k/rl3SGu5JWki9AirYvedGF5FzP4eGsVEY+dboK2hp1oX4nzOA9LmdkArx2lPG3xhJG3tdoUoKT6/Gz4SnQ10DGi01POfKVNZ68ulip4dmZfP1zr6k1/CeIM6yqUqcozgafvXhcKZ8WNEP5FZYVcQw7+UxpYMPK2Ypc0E0+W5fjgKH2HYOJtSWhhNpPdmQyCUYeFgWFghzwxy410B7I4KSkTK05WlPVrih/X057EUxdlodptm4+eHI7V09Xp7POGR+cNvlRPY/1vbP2hqbaaLGBUVybanJSocEZ/RtR3uGESgmw6ebT0HzsAPJYwC5EayHol1o7ifCpqWYX86YDIbrsR+//n95fpqmtTfA/+v+f9n99eOJQLe/Vt2jHhp7S2umwZMOVuqz0ryQ/GdWVekXoyF3WoYgrNz0VMPcS4ZHUFR+bcZGWU1E5RcRRPKjB/HzA78FU54NthoM2s77emEtGbk7Ox4T2u/eGZhaabT5XO+aXKkKo/MVgkPFeHyud6NyhCYm2Smo4wNjZrE4jeA+4ecoDtzRn9jxk7pvtw0Rudn0ey5PXcH/T7S1rsFnoKS2hCn5vY4iGv0qAsE5/i0/oEbMu34/gjpaAfEogaV7aBK6ZaXMsawI7jbS73fNzC00YmNU+wISgckzwr5TBQoeCD8eU4BZOjA0UHQSHuow9qDCl0x5QkicHbi+gNXy+tLWTdvQ5uRe3iVyXLq9WahL//WzdDHlOUL98vD6uLU3Jewj2jgxU6P0mvcZTmzNoA3tJwLaDcc6I9zIa8ErbccEt3jBtplaykYEF0ziw8GSiBVtfV5V14eUOzy0k+u1uaZ8IXQ4dVLM1gpO//vjzVO46wnhBmfYFZBiQx5S0QJMToMmAacZK1sAZaadTQcnONdeWwChAzVMb75TTvrd8mnTO8028l2HZa+1FLCDd3f8ex8x0rgNf3QWWJYUYzNtSZ1DZDAKlhbGlzVmoe40YCeYIhhZQ0pxKIZTm8S7qOU6YE2EZnTAFLYMpx1M746kvSloELJbnKK/LWI8XzBCmPEsJczNOR/KcoTFcGzeVJ0YWiqjem1vApGMSDpOzo54vFosE43ZiXT5obf3g3ej11W/jq77YMBrclnIPPJC7k9m0FiXa3C6RoAav4dnwp+Q8eRYHResDZ9fJ53um4j0+rHZD8nc5a5kceG1QlcjSsW4bs2qV95OanzezOGuvPB0d6yP9ZakquEixWq0m6OmDK9drWf5Sk4tvAzcHXWRU81JslEoE+04ELV7YSqQ/Kk9UtoPhf919Jt5eyZ3HVhB2YngXxbD9Id43W2bZ8X2oi00K8inyfa/Jc0Gc5enF9niz86DBVkma09JkeUD/Bi5UujE=
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: eJylVcGO2zYQ/ZUBTwlgS9vdnowg6Da7DdwWRdBNkUOwwNLSWGKWJhmSsuMIvvVL+mn9ksxQkm3Z2RRBfZAlkjPzZubNYytKDIVXLiprxEz8ibKEN7WNFuY38MpjiSYqqWEeQiNNgYCfIprApyfCY3DWBAxi1orLiwv++z/+CmvoI7Ib6ZxWhWQ3+YfAvloRihpXkt/i1iF5t4sPWEQydN469FF1SPYu76KMTTgyWFirUXKoMcy5KTkYBtjUGGv0QI8DNFAB0MiFxlLsCOY+ja9hGXv+Zu7KLK1fpSTPkjgEucGlMooPzcujgCF6ZaqzgEdxDoYwT2tLRZnZZUpuACZ29ONWfmwUmYrZ+7P6jTK+33UGAYvGq7glg1ZcO/Ub8uv9btKKn1F69NdNrNPK/UREWQX2/K1qCDq3ouJbwiAqTG2V7ELk66ucqLFUVb6Hljt2pcqpGswZkl+jDwnRuCg3uLLQbdO5xlPjRB2jC7M8L2lvKp3KVOWliZmygpM4aaO3ZVOkUj7h5r88UC0r6tdT5qHbPgVyfyj0HbO/48ZQ7j0XZLcwEYpD1TR0KYSRK97lTlivPg9EGwO7fjOHR9yCpFPckm7oMnhLJFlL3eDAmIeRnwfowsCqCREWCM4T3T5hCRsVazqcIMEDPDM2YnIQvVQ61cDJAp9PALMqO3E7g97wxdY2nssxJXAvHzIevGNitWKRvn5JE0R5/Pru7XluRYEhQLSPaMDJEAZ4naceM80hjEDAvoJJcpJyJANa6SvOfRM8BzzDaV5Ju2SRtItESnFvQ+Oc9fGnQz/3LVGvD0tjIhxz6CSbvRE8+/fvf56zKkm422CpQg2ljJIUq6ilqRCkKYFoRhPftTPRThXcJbtWlFsG8wgNSTft6OU0WDqNqiKpS3MZt5PenlUPDvMfJhSzVJWKNLobqTXGFCxYrUpwtoSIRW2sthUJ2aSTTe65BIMb0LhGzYRSpPRJ7+SCOBG3yQlR0LIc0vHCrugCSCqZGpbS81g1OuUTuGcSlo3WzNyS4DDOlTSGcqOi0uVBQoHcjmEKiHREwsvs4qzmm80mk2k7s77Ke9uQ/z5/dfvH3e2UbagbVBY9ah7w7JS2aFZUnGG6WIK6fl1eXP6YXWU/sK2zIRK6IzzfdzWOmNAebsrvdNOzN9Ja7rQkudj1xWh7tX0v1lfdVUx6Sy/H1meaS/JUU2Js1bYLGfAvr3c7Xv7YoE8XAhVE+sSi7noY1IlF+pFFLA2pY7lPapPU7OTu3x1fDa9vec5lLwIHAXxMAti/sPdhy2yPfJ9qYQeBnyzZXzV5wV0mSXq5P97tPGmwV4/uNBeZb80vapxJxw==
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: eJydVcGO2zYQ/ZUBTwlgS9vdnowg6Da7DdwWRdBN0UOwwNLSWGKWJhmSsuMIvvVL+mn9ks5Qsi3ZMRp0D16b5AzfzHvz2IoSQ+GVi8oaMRO/oyzh3fwO3ngs0UQlNcxDaKQpEPBzRBP44ER4DM6agEHMWnF9dcX//meqwhr6ETmDdE6rQnKG/GPgNK0IRY0ryd/i1iEltouPWEQKdN469FF1IA4pH6KMTRgELKzVKPmqMcK5KfkyDLCpMdbogT6O0EAFQCMXGkuxI5iHMr6GZZz5UtnKLK1fpfrO8B/z3+FSGcWH5uXgrhC9MtXZXYN7joEwT2tLRUXZZaqLMIkd/TF3nxpFUWL24axrozofd11AwKLxKm4poBW3Tv2C/PVxN2nFjyg9+tsm1mnlcSKirAJnvtADQUdW1G1L14sKE4+So0W+vslJC0tV5QdUuVPlVO1DGYlfow8JyLgNd7iy0G3TucYTS6KO0YVZnpe0N5VOZary0sRMWcHYTzjztmyK1LwLaf4rA7WwIoYuhYdu+xTI47G/Dyz1Tg37Lh/Yl93CRCi+qqbhSlcYueJdJsB69WUvrTGw23dzeMYtSDrFdHQTlsF7ksVa6gb3Gnka5XmC7hpYNSHCAsF5EthnLGGjYk2HEyR4ghfGRkwJopdKpx44WeDLCWBWZSdpZ9AHvtraxnM7pgTu9VPGUzbUUysW6ddPaWaojp//fH9eW1FgCBDtMxpwMoQ9vC5Tj5kmD0Yg4NDB5C/JJlIArfQdZ94Ey5+nNk0oGZUsklGRIynmNjTOWR9/OPJ5oES9PS6NhTDU0Ek1hyB48c9ff79kC5LwsMFShRpKGSXZU1FLUyFIUwLJjGa8ozPJThXMkl0rqi2DeYSGLJp29HIaLJ1GVZGvpZmM20kfzxYHx7EPE7qzVJWKNLYbqTXGdFmwWpXgbAkRi9pYbSuyrknnkcy5BIMb0LhGzYJSZOvJ4eSCNBG3KQlJ0LIB0vHCrsjtky8mwlJ5HqtGp3oCcyZh2WjNyi0JDuNcSWOoNmoqvRRkEsh07KeAREcivM6uznq+2WwymbYz66u8jw35r/M397893E85htigtugRecCzU9qiWVFz9tPFFtTxdX11/X12k33Hsc6GSOgGeL75CRyJoD2+iN+eoddspLXcaUkmsetb0Pb++kGsb7rXlhyWvgyjRy5LhlRTKRzRtgsZ8A+vdzte/tSgT85PLZA+6aZ7B/Z+xLb8zLaVxtKxuSd/Sf518rTvhg/B23uebNmP/dHynpPl9V84+37LbAe5T92vg8CfbNJfDXnFvJIJvT4c73YuBhz8ojvNDebn8V9TNDld
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: eJztVsFu20YQ/ZXBnmxAIh25JyMI6iZuoDYtjMhBDoEBr8gRuTG5y+wupaiEbv2Sflq/JDNLShQlC0ZbtKdeJJK7M/Nm3uybbUSKLrGq8spocSXeo0zhPSa1tUpncCvXJWoPv0idSo9wdjd7MTkH/OpRO7YYCYuuMtqhE1eNmFxc8N8/9ZkYTS+eXcmqKlQi2VX82bG/Rrgkx1Lyk19XSBHM/DMmngwrayq0XrVodi5nXvra7RnMjSlQcqgh1KlOORg6WOXoc7RAPz00UA5Qy3mBqdhQtDaT1xZT+lOycE9hGka4I39UCyrGU7W4pWrSe0gX3uBCacWP7ii1bWhp0z788xVR6d4e5xnDEcLTTJ1AB9MQf6HQclW0LPHfiPJOzrHgAFsGnqfz4x6JpwP2BRzwu+He/lIry6E+tWn1we97/q+TxNT7bfA/D/8lD5vDHYfH/smDGuzI0DEc5ddk2IjrSv2M/EjsNuIHlBbtde3z8OV+JLzMHEc4mYOgTSXlagiIyDAQL9lexMvLmGRtobJ4hy+2Wz/jDuG47PwwMLtE6wKuYTXfYGmgXaZ9taV+E7n3lbuK45TWxrJSkcqs1D5SRnAqQwe31qR1Esg84eY5D1TZjNM/Ye7a5UMg9325Zyzh7VnYFn3XRbL9MBKKQ+U0PUKItp8F82Gs+i305VGnXd9O4RHXIGkXU91OjghYdpeyqBHMIrThw8DPA7RhoKydhzlCZanhv2IKK+Vz2hwgwQOcaUOdyg68laoINahkgucjwCiLDtxeQWf4cm1qy+UYE7hXDxEfn/32asQ8vP1obClp7omfPt4d55Yk6Bx484gaKuncFl7rqcMMSsMABOwqGOZmOKfBgL50FWfewkFTemEYDQ9gmYQBTJNWMbeuripj/fc9nztK1Nv+07AR9nvoIJudEZz9+fsf53zkJcxWmCqXA50BSWM3yaXOEOhMALUZKVtLZ2g7lTBLZqkotwimHmq6g9BKsRg7Q7tRZTSvw3n361Fnz5oBSS8DI4qZqkx50pyVLAr0IZgzhUqhMil4THJtCpORcI9aTWLOJWhcQYFLLLihFF1Xgr7LOfWEXwcn1IKGyOTtiSnpFiM1QQ6EhfQsZnUR8nHMmYRFXRTcuSnBYZykBZpyo6LSDYgUI6j59hRQ01ETTqKLo5qvVqtIhuXI2CzubF38bvr65tfZzZhtiA0qSzEgD/jspCapy63qk2uWoJavycXku+gyehEuPsZ5QreH56/f8Qbd0PRXvr/hqutiT9/iqpAkG5uuKE0nv5/E8rK9V5IA8/QYXGBPiTDpVU6ZsnnTzKXDD7bYbPjzlxptmBNUIWlDW7VTYytXrNqPrGrh1FY8CIL8BHk7uNFu9ofG2xs++LJThV4RH4Midg/sfbuk13u+D8WxhcC/rOFPmrxk2kmjXu22tysnDXZy0u7mavMw/QYyNVAF
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: eJydVsGO2zYQ/ZUBT7uALW28PRlB0G2zDdwWRRBv0UOwwNLSWGJMkwpJ2XEF3/ol/bR+SWco2ZbsGEW6By9NcoZv3sy8cSNy9JlTVVDWiKn4gDKHD8qvxgvpMYeHOpRogsokX4Cbp/mryS3gl4DGs8VIOPSVNR69mDZicnfH/77J59FZ5518ZtbQXmBXsqp0dzP95NlfI3xW4lryKuwqpBfs4hNmgQwrZyt0QbVojp7nQYba9wwW1mqUDH8IdWZyfgw9bEsklA7oo4dQeUAjFxpzsSeYDnMOROqvYTkj4Wr8yiytW/f5vQikIpLJIt55i0tlFK9mee9ZH5wyxcWz73uWcDKFWQS+VBShXcYgrwPshbmnP07551rRpph+vOB4wMrzvjXwmNVOhR0ZNOKhUr8gL5/3o0b8gNKh4xfjzvNIBFl49nwVkKBLa8qOJQCiwJh3yfYi3dynVDtLVaRHXKk7+hnLoR8G5jbofMQ1JO4tri20x3SvdpRiUYZQ+Wma5nQ2lpVKVOGkCYmygkM5Z97mdRYJvOLmvzwQowXl9Jq5b4/PgTyf6J5zn7QVdCD9WC+y3RgJxU+V1KLxCSPXfMqEW6f+PPA0BPbwfgYr3MGQzgSeqIw2Utd4qKmXgZ8XaJ+Bde0DLBCorJfqC+V3q0JJlyMkeIEbYwNGB8FJpSMHlczwdgSYFMmZ2yl0hq93tnZMx5jAvXlJuEX75dWIRfz2U2w3iuPnP54uY8sy9B6CXaGBSnp/gNd66jBT08IABBwZjOIUNSYa0E7HOOdNcDdwwzMaVjmZRZUjOVOcW19XlXXh+1M+jylR705bw0Lo19BZNEcjuPnnr79vWb8kzLeYK19CLoMkbctKaQoEaXKgMiNN6Nqey05lnCW7URRbArMANQk9nejl2Fu6jaogAYvtHnajzp71sScafkRv5qpQQWrYSq0xxMe81SqHyuYQMCuN1bYguRu1Ass5l2BwCxo3qLmgFM2EqIpyQTURdtEJlaBl7aTrmV3TqJCGIMeExfAcFrWO8XjOmYRlrTVXbk5wGOdaGkOxEak0ZkgxkNNx6AIqOirCSXJ3wfl2u01kPE6sK9LO1qe/zn58/G3+OGYbygbRogfJA+6d3Gb1+qDK5JolqM3X5G7yXXKfvGLbyvpA6Hp4vn2QDqqhOc3V/zHnuyoOtJdWWpJs7DtSmk5+P4rNfTu8SYBpMfiVcFWESa9KipTNm4Zv/O70fs/bn2t0cU4QQ9LFsmqnxkGuWLVXrGqxayseBFF+oryd/WzY94fGu0dufNmpwkkRV1ERuwV7PxyZXc/3uTi2EPiTNfyrJq857aRRb47X25OrBkc5aW8z2zxM/wUxW2IP
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."
sidebar_label: "Toggle extension"
hide_title: true
hide_table_of_contents: true
api: eJzlV9tu20YQ/ZXFPiWATCmO+yIEQR3bLdRrENvoQ2rAK3JEbUxx2d2lFVXgW7+kn9Yv6ZldiiJlpUFfChRBAIfizsyeuZ0ZbmVGLrW68tqUciqvSjUvSBgrMu3CI330VDqcOqFL4ZckqkL5hbGrRHwDOfqoVlVBI0Gsqss8yPxcUTm7FBemLCn1eyNCFYVZO1E7sk54IwqTs9219ktTe1Ep59bGZizR2tJWXN1ezsQaquQTOZKmIqsY8CwDZEf+amc+ws+uvfIEwUpZtSKPq+T0/fbA1RvABESzCIA7hFDTfFwpv8RzCQP41R3jypG09FutLeF2b2saSZcuaaXkdCv9pmJx5y3Qy6a5i8Lk/BuTbVgiNSVMeX5UVVXoNHgy/uAY1PapKTP/gAiyM5b99pocn1L0tCc4N6YgxfjblOzQDd2elRnfSUgne65dLzn8o7XbNH0333f33TVNPHIVSiJiOZ1M+L/hPdd1mpJzi7ooNqKuMlyZDSMtXJum/zokwI+qUICkbm1xLG3BxyWpLJTOln+dTV78q/QNgmetsRcmY2fD82UvVCiRz/jVae+RaqDIyfY9O5tMmiPmn3jXU5FvVIbuq0Ljta2y836YzdtS1ehQq38nboDD0Jx9waF5R87UNiVRGi8Wpi6fBuir2CBfaIBmuM+WqhDg/EfCxOBrDmIEJUdpbbXfBKo+r/T3xI93zWgr35CyZM9RgeENe61y5nT5oypVTqIbABwRQFkangzAFoYAq8nx48sxErDQ+bhjoPG2x+uNZAyM8Ni0uKSVaR2AXM20IZfeV246Hmc4O1GVTnRuVekTbSSjHhp4a01Wpz7w3nEzn7OAqZbzTPyEuovHh0Du9pG95gKLdbGLb5dgFV+0wy+mZj/+ztvmDwUrDxN8/nYmHmgjmCJQ321dJ4In7KMqatoN2fuBnXsRrxGr2nkxx2JhaaE/YkzwNgDhAEnci2foLAoGvFU67BiuUik9x9KR5MmB2aloFV9t0JccjhOAe32fIKSDStrKefiFLWal0JXyu19unvoWphg2lQcqw3aygxcttZh5hRmAEF0EQ1eHYRQUZNexnLcwZrn/3+2XhKtdh/UmWju1dLkwOyJRaSASMIbmKnB1VRnrv95nvkue/nb/algy/Wo78LtTEs/++uPP57waKHG9JqyFS8GTE3M8XaoSzafKTKAg9aJNfChQnXI+zaNGFBIx87zxOZwUixNnIE06x76Rcbn4zajVDwtnCuLj16pwI9yZ6Vx7kEdc/8JlzhQ6E5XBPkHpsjTYIUF3vQ1UiZLWoqBHKrj0mPACK6o5qsdvghEUq0HaWTw1CLhWJSCH1Ab3LOV1EfwJi68ScZNRdQY4jHOlsNta3kfB5CCRkLFdv6A8Ua6nyeRJzNfrdaLCcWJsPm513fiH2cXVT9dXJ6yDbCAsxSB5grssM2m9QnB2fchkFfN1Ojk9S14mL1i3Ms4DXQ/PjcnzYrjkZkOe72bT/+MToO0hD6tjgAFpNW2gty3hv5ePL+NuCcoPg2vv+7S/zoMglwgYa2y3c+UIO2HT8Gu0pA0zCIFWNlRnnAwxLujLBYr0cMPux/LZu3aSPxef/tw46suOlkvm5ECi+IXHB2btwedIc9ftqgFdlLiIGE5u2M7ewpO9g8dM1GCmq/w/yvaH69tbJst5+1WzCiuGtGrNn0f4O5W/4l/4WAs9FNYafr+VBVijxtSGTDTLJKhaSt6Po4cwjtoHduxoSA4nU/SF/7JnR1VecSdhQLzuxOPJJxU6Lo/SnCD+DPobYmdTQQ==
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.

## 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></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: eJy9V91OIzcUfhXLV7tSMqHQq2i1Kgu0Tbut0ALdC4rEycxJxotjT20PIY1y1yfpo/VJeo49SSaTsHDTCgkS+/z5+DvfZ5ayQJ87VQVljRzKm6qAgCKUKFSBJqiwELnD+BG0FxPrBExRPKJTE5UDu4naKzONPhc35yPxGbTGIPApoPEcticDTL0c3spTcv2t5SrvetLhHzX68MEWCzlcxq+KMsphcDX2ZG4NxQm8BVWlG8fBF8/1LqXPS5wBfwqLCukEdvwF80A5K2crdEGh5931ac62hznktNuNX6ASdnKoE83aRKHzIliBBsYaCzHRfNKehKJQHAT0ZauMCWXFbmWVKlqVjK3VCGavlEtKxOHEqEnc9P4cAsgVxQTvK+vCa0I1pq3jxAilDXZ0/poAbClG550AhIudu3050GkXSe2Aq14LC7exTa1jbuvdT3zX9T10+WSUzCie8ekqjo+O+M+hkSgOY3t/GAivEzWtXSrlf8IvOAeLvfZ+VD4wftcl0SEODTX5qYCzg/PQLaJl44Ojsd9LenZoRhgeBmb4svuP9QxM3yEUPFDtiYv+FKcZtVfAa2QKbjd6MS+R6MlFjmoPsV8P7h7cItpiym3Gu9WrgUV2HvPa0R7ZLeVppX5G/ni36i3lBwSH7rQOZVwhEpxRfZZCyqqObQfekoPHk0G6vMEGcQNCXL+NuMG6iH5reji9Iysfs++25RxnVqRtsqudprUyhMoPB4OC9vpQqUxNHZiQKSu54M78O1vUeUT7M2FeinBFgsCa8Yy7T9vdQu62Tb3isUmgXLd2OwxpgVDNqUqCUkyR8Ce569apP9fz2WGky5F4wIUAsuJWphZn4pqA8wi6Rp4nRtH9Tpx7kdKIWU0jN0ZROZyoJxq4uQolGceSxL14Y2wjr8GB0rEHFeT4ticwm2adsEPROL5b2NpxO/pU3Pv7jOegDaKlHMdv31s3A+Ia+dPn6/2z5Tl6VqsHNIKJdF1eitTULJQRO0WITQcjV8WBiw6s66njfG9xgpjVPm31/OIJZpXGr/BXFL8k9FsFa76v9Sh93VMXXuacykwsh2KihTwSLTGqYjz5uuKI320xtIGB+mG7tAu+Nm47Hdw4iTf//PX3W+YPEFdzLJQvBakEkDDkJRjSBDDFri4w1FXOyLCP1AyXiVGglxORk0c96XtL1qimZkPRvca/w4O+RzkLNVWBCGye5IiTeatVISpbiIB5aay2U2LtXiI4xhkIg3Oh8RF1fNSQLEVyhzHhkBSBgxDsLQGIzXNLV6fAUMkRJPF4Dqe1jufxjBMQk1prnhZ67cQ6ibwNnY2aSkpHhBXvfj15BHQC/nF2tNfz+XyeQdzOrJsOGl8/+Dg6u/j16qLPPnQb1Ba9c3mC57WweT2j5qwnmmkv3dfx0fG32Un2TXzeWB+oulY9zVt3T8EPPnxjD5573u6gZLmV/P/sOZ3GLtDaoNJAPLdqOrpspONWPp6kxweJB0tYy7srIMyUBySE2LaknnGs5XIMHm+cXq14mebbRS2jXoOLAE3KtiZb1pwH5mR5llrRv+aK2ZwoNFJ05yXEEpE8mKWq8FXbtl5e3jDRjZt/Hma2YBcHc1rk30P5O/3QFxtvJ3JOXF9KTXNaUy/IJoVlMoGGTrdS8hClpPnAB1tvmUWryK6qpLPwbz7ZQZd3jF0i9/cb87TzrMOGh5M13zq/Nf4FG7/Xxg==
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: eJy9Vt1u2zYUfhWCVy1gy1myK6MoljrZ5rUbgiZBUWQBQkvHEhuK1EjKjmf4bk+yR9uT7BxSsuSftLkYhgCOSJ5/fuc7XPMMXGpl5aXRfMxvq0x4YL4AJjPQXvoVSy2ET6EcmxvL3n+esNpJnQexy9uLKfsklALP4MmDdmRpwL3IHR/f8ffaLNlnU1s2qZ03JVh+P+AW/qjB+XcmW/HxOiwluuFjb2sY8NRotOTpSFSVkqmg+EZfHAW55i4toBT05VcVYNhm9gVSj14rayqwXoKj0zaFSZfBMaXdEvwqKmbmx9Jv9uYSrGPeMNBipiBjc0W5DrjIMklGhLrqhTFHr7AfWSWzXiQzYxQIfRDKFToic2zaOI51YBfCC75Bm8K5ylj/ElONaC+dYKEw3kwvXmKAJNn0YsfAZtC7uruQVS+qzvz9vuSxm0GhKIba2sU6nZ6c0L9jIM2OQy/AE/Ezl3ltQ7n4/4QnYa1YHdTtg3Se8NSGhHEf6yzUkx7Ko/jcD6In47zFRjxwOjmGWbpvLUr4tvrPdSn00ILICOD9Dgj6aKeB/gtwM9UZlRscWxaAhGEDa/SbyrWNdICnAKfgsvN4v3kxllDOQVpbPEO5NT+v5Hugz/vNYM3fgbBgz2tfhB0kpRLjM2iSV3Uou6AjPlqcjeLljbYgGz2u0lHrd9jrCPJoF9i2weFuJS6gNCweo1xtFe4V3lduPBpleDYUlUxkboX2iTScYtxrQWuyOg0M8IyZb1m4RlYm4n5G3cXj/UDuuzpeU6dEHLbV7PAfNxDI5KpA9AQXEXKcCm2s/LNtyd3Azq+m7BFWTKAUlTI2aMJuECsLoWqgFiLgPOzYeWDRDStxtrAZsMrCXD5hjy2lL1A4hMQe2CttmrHmrZAq1KASKbweMEjyZM/smDWKb1Y4uKgcQwzu7UNC0O/jZs1nYfWjsaVAeuG/fLo5zC1NwdHAeATNiBzb8KKlJmYmNdsJgm0rGOgp9FhQoOEaK073FpqGiOxjN1Ivn0RZKfgKZYX5E2dtN0SadTsSaEnGpZ4b0iESFWkgUWRLScBxdUWqP3Rg2d63/Knb2kVZH6B7pdoqsVf//PX3a+IGwa6XkElXMCR9gTyfFkLnwITOGGK4G4qEaZkSBMwCs7YJm3p8pyDxOFDzoTMoDTLXW/odNPp7HOcG6DOTufRITss4XciZM0pmrDIZ85AW2iiTIyMPInkRoATTsGQKFqDCAwJHTiBuMUPAIduTEcS3QaSQeGrwjqTQGHJAQ0jPQl6rkI8jQAg2r5WitsCXRYgTiVljblhUnGJIRuGS2xZDRCPCT5OTg5ovl8tEhOPE2HzU6LrRh+nk8rfryyHp4G1gWdTO5TFqzMykdYnFaVuX+C3e1+nJ6ffJWfJdeEoY5zG6XjzNY5IG8tHHZEj7uffjDjDW3QT/L5+osYs87o0qJZC2Nk3d1g353/HFWXw+IP3TEOpp4wggrjsyBJAvCywGqa/XM+Hg1qrNhraxQ20YQFhEYQPy4jhq6ZKmxiOxKp/EhIc3FCSJIwkGkt17vhDJRw3imcp/VbY/5K5uiapmzQu8NBmpWLHETfod89/xDxcm3EFgjbC/5gobsBY5yUezxBKiIcRuGDyGYdB8UGLtkV71gtyfCzEX+qXMjqq8IVAiPb/diseTZxW2TBql6aLpgfAvPWOMuQ==
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: eJztWm1vG7kR/ivEfmkCyHLs+HqAcDhUsd2r01zii2zkQ2xY1C4l8bwityTXsir4W39Jf1p/SWeG3FetZMe5A67XS5BAu3zZ4cwzzwyHXEeJsLGRmZNaRYPoMku4E5a5uWCxVlM5yw3HNqanjCsm7qV1Us3Yh0yosxN2rJUSsWNxKoVyfTZMU720bKETOZVxOZKmoy5/skzxheixzAgLz75LIqZSSfzZY85wZXns33PHmf/dY0Yk0uDHLj+e2R5bignTRs6kggeZwFzSrdiCu3iOAnLnjJzksJgedGMxT9MJj2+bqwKBtwnCJiLVagaq0DAXrMg6ppUoVzpaWScWewuu+Ewk4bWF7yilHQxmOaky6Ue9KOMG1uyEsdHg87ql8gvQDWiyoSUYI7Et424Ov1Fj8OTbzhJ4Y8Q/clBGEg2cyUUvsvFcLHg0WEdulWFfC6tXs+jh4dp3Fta90ckKezQ/P3QsFTwsLggx1WhG1OJUijQBe+aW1pQZfQeqTqCH8QvETpXcAzZGWcc9Nq6r9aTU6lmCbTUTn4CFh/QLGwoTo4XxmaMcIvngzYxvCkP/GOw8LM2MrYWVYfyYzF6+GYnYCDfuX6kO7QEmHGodlMOzLA3A3f/ZoobWm8rVk59BSJioqcqRUAmoMV15JXrVAXziOVczAVibAgSozWOjpjiv4Tm/E+BioBmYI9hj14obK8Q1s6V08y2LBttlwjgpLK7EQ6oNl/aKEJvYs4XOB5yt27xPm7PC+zbvA7XlVhDO3Fza0u3OXM3FxCJzqx7wUrJzLtKtH4IuTR4Nj3MwRjntbmnm3DK+yUxAAFkKhuzR4OKp9JZxqgG2N0ba25va2BsF/5w9OPT26+407rP3gBwAKVqfp0BsK+AuMAWZWALV6KXaFOnFxejgcMAyvlogrJaABOGQDIEAuOdRq6duyY1g+EZgtx776XQ0PO6x0fGw/k00pH05YDaP57D+tkKCDrPcZNoimiFA0GqQVpVYblUn2POOp5L4kfEZB992pMJdNF6aeUuAaGIUMf+Anl4RSg2a3Bi+QpKF9dsO1uzCbCP8tD7GsEPJXje5keMQMHnu5hClrNdBYGKPEFpjjXYXhev3UYAm9X2l7LVYiR9b6dywGtPRB7fzTBfz8SQhW/L0vMErjwgzhFVnKEINZf7DQJfGs2XK5YJh5LNIAQAQy1KpbhENgBrQH7HCBlT67JSDPm/FqpoRvbb60oBMNr6LXWGd0cne208XtS7ek8eJjnEhRbcFPDc6wfc5hDHqQjJRR/bp9XGtm0eFb5Y+pUq027MC0wFEPq4RV+yBhKtG35YKPcltmYiggq3UfyKQEvzcY5tPgDV+kBBDEFQw1qxIVQL1Ule4ogEnxz+9Y4BH6LWbjP33UbEl06LkBGJKCFkhczUlWOOeAx8KSAnWV1Fu1EDkiRxkMhkcXEUDdhVBTJXpVfQwRjOHNdC7cVhdkOocokVN+i3GHwlHyYh04GULfQczNkMjyt6OjGxq9KLFGr1IeMkRzk25AcAkIKRVkDRUkz8t6EFHzCSXc0lsSvYKVl3KNMWIAXPGeeppEcQFEUEAfIhjbRLpYxeKi2ZqmKvPLoGCAat/u7g4H4Hxk0zLgpmKJ5gwFvIuKLs+3KIJOTv/MLooSQolIBsD3S6B5ynwYMzILTt89YraOXs7+vCeeVrwGJhrTHsCGrussiuh6bBHTdXeak/TtqW+nkEw4MexsAFkdVj02ceQDIJhhGphBtzWCkf02Jmzdomy4PfvhJpB4j44OHrVJZoT90FXvm0SDEKxs7AwCG4KTz29PDljnyiU97xHe4Sy8Ts9Y34McToknxJcf8LVLWEmV66gBOn8Ar8izUFzos2VT7yYX/LTplV6Y16PzdrayEgZZDbFfgv0h8mzgUEQHFrOGT2+dvBT/INpgM0A5D5EAXY3t0HHPg0Pm7boK/YEzTw7ZMyP9vul8ulyl13sczHObKP1525+0R++dgNRbmaftcBqhmdwwsZMv2CWSHltK1f0m5jfVbL4Wwt+p0RIJROFTTXlFbvizW8ovvyRfv8u0u9dQGzg4gsyzf/h1KOlji/NEJ4R8XvRrXx+1AT44hSWirs/+tpubbKJ1qngamO2M5UgO4IyYalUFKkZH528WSwGNSqN1fJ2QxixUUTGEYkAG2A9GeQLr4d1roL8XsyE6Vypk1UITrHYGwqQjeX3GKV/l0re0wBI9RcZ6huoTqvE1k1x8O3Rt68OvoFUCunTiGdLQ2M3qjdfLsrBn0GUIt2bC55QsX0dHQMpib1jSOaMTjsTtxIgFc6U3rNOG7FJoJWhyYkc1YV8bsnsXOdpEgqNYEP4EFoLBTryKeeTc0qI8x+mdFbQJn7gXBLx3FfiwR+N0ZtqPsW3xcYtqDYc2RQjEUjrcr7h+VmYCk8MarzkX6JBKbW5CVkJ6gtbblolcMIze/RUJPKGag5+w5Mi6fGcmxWL9AuxobxNHw4b+g0hxhXbTHSyQu/DT/u8zG9WTdijAuNQkb63wdcbLhu6bD/VwCF+V4R6TwHV8O16Ft0oOPdayUBRjigmoRDXFmpJ8KIzgglM5lnkCYcEjcKHz0lQuQEcSL1ei8c6EXWtnnQq9Zxbu4R8LMV05x2FDYgpQtlQ2EVlC8UnqT/6qlzR+8HBF/lBdVDzOSplLKBXky8CzO7eX1WjuziqxPsREdrG9DvZAmErVZZDTlqc80UPXfi+VCHB/yftMNuqOfoi1fyaxNCpvKfFVOoKm89EtNKFFn/gaR1A5WYKUTvxByGQddwJc+O9O3roJJiniAC+B9oqd12B1VDHHbRWyrCF0EJdAFHtu3XYdaNP27bf/L/Q/8WWoxngBdPYBu1KBNtZYGesKPfajexh66WCJxykYpfug2mQfer3eYQuUoDfhMDKwKQGtmEB+DqOcwOrxNyORkGLDzauQiZQZkfc8qyMhuiIdo9zsyzTRkP1fleLn20ixgxXgKCgDELZMJN/F/jzGjHxRnAjzDDHbQS8QWrlM7y5ELUufXjcI/cC6c11ghcWcqJevLYwiPbvXu/7MtR+GSL2tUzifR/R9tdFEeghQonQ/btuSJyIhWa+GfrlBvK4aO5cZgf7+wm07fFM9uUMbOf6UhOumxMA5pPcA2rLNI/NMAIV4A54y3Drm9uCXFd6HqFzezYttF0VafyLcOfDG6q69TEMMYNAveHpiBc6mYFeCO9Qo2lvWYGAG/OMmf9M7WYHeMs9uieBzsvIxuwFIEoUx64yJR1kPBYve0z0YdPfnHbAwsDvcIOG6tgD4b4f06aljqt1NKGnv2qz4MCI0dtPF5trCzUVfYuMAXlHIZ6fKciM7tQQgpUaJEalfRsNiMokAe1GW2vk3o/V9ZjTiviC9ss4s71AW/Vp1hE/Fw3XmwW6etvuys+2ukCrBlcJ0S5mVS1b6ghP3FZLNdVFFINJKDiQKPCFPMu0cX+poF+iV/5QvWr6TN3dWoYvB7EX//nXv19i+OBsBPqTdu7jirj3l2qIEsEjq9tm6KEyrnEfXhmh+osV6XTPaugt5EyVFaxeGI8pa63qY3t44wHM5YDCi2sU8DGrcSORaYgGIp4rjZUTvGNGOS/dWKCrD6m4Eyn6HgUITKb4BNzH+TNU8Fa98JenYg2Ik1zF4WYHLc+IGVZCq4O5aZ6m6OQJiINywrZEeV6HNAKYtQ7ZYYZbT3bYf7Wh8+Vy2efU3Ndmth/G2v13Z8en70enezjmocoyKjsgzSQ6zheFC8DUyNbeXoevDo/6r/sHdDFIWwfS1eTxdwrZh7OT4yJktAxeS43+uIH4q9xADLyH5b/9LOWSyt6EjXWI1p+ju9f+2AuEo/1NiNjwG2N2VBy4wI9BeXgD9DUHuXD4ej3hVlya9OEBX9MtAEwgACjckHf50C4tbQ6jwRScTOxAwouicv6Sbbkj2bmqIqgqjKgUAuEJfmJpr3aH8uG6LBSRXL752H997wInqYZvpOuYIfgRQzqz3Nm3niCdX2Kcm4SrmAvakEaGLzF6wP+D6Ar+ospJIRQB6P06SoHvcrA09PHTYvziIZpWmcQtZRLhR20L0dRHO6nwa/HVzy1DvkMOgNj+fdndt2wdUIZh3xutcw1C/xdZrMmr
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: eJztV91u2zYUfhWCVwlgy2myq6AolqTZkK0YgiZBL7IApsVjiY1EaiRl1zV8tyfZo+1Jdg4py/Jf0i65GbAEsCXy/J/v/HjOJbjUqsoro/kpv6uk8MCuxawE7dlZ7XNjlRN0zfrsYGwsOxf60R2y25s3xwy+eNCOeHvcwh81OH9u5IyfznlqNN55ehRVVag0CBl8dqRozl2aQynoyc8qQNVm9BlSj3LWLfoYpbIRimWkviYTlc72GIlqxyqrbXhL2JlnBQjkNxqYGbNhFbkuhJUXFiQ+KlEMmdCyvTtLU1MjSefa5aYuJBsBq6yZKAkyQUvxuQLrFTjyY6fkXQ6us4EWowJkh3BkDNqst0JxGSgZxkCit/To8325urbg8DS+vIex0ioEhC8WMVPKks77Vv0Dnu/z/z/kRPijS1cZ7aJxx0dH9PV6SP/X0N4I2lLkDbpYu28I3pWWpAwcm+aAcbMheK0cphxbhmKVzlUe3fPldvu9yXCvVQeqix7nLZb4lnXfZRm7CrrHCixFQ4sSXlvDBzGCgoR/O/4/dRK3W9kqaGv53IB8cKf3SuX7f+xfFvvFVkPaKO2dxfjQNCsHaW2Vx6l5P+dnlfoV6BEzOufnICxYsjGcPPS4F5kjDbvt77QtjsQl+mvQIF7VIemC5PDB5GQQx+SgtXPQ2NcXXXl95VyNKSQb7QSsCyauB/U9lIbFa6SrLcKN595X7nQwkHjXF5VKVGaF9okynLzaSLs1sk6D+XvEPCcBg5zRRrCH3cXrTUMeVpG/oY4dS2EZ/xZMIh70uCJVOQgZVERI8yb8X0O4tgB3dn3FHmHGKKiU9bTZSqjLTkRRh5WE0DhckzNkUQ0ra9p8aOlA3H8ByabK50gcTGJDdqCNjwPUW6GKEINKpHDYY5BkyYbYU9Ywvp2Z2lI4+mjcu2FCVdRF2pyPwttPxpYCxxz/5dPttm9pCs4xbx5Bs0o4tzQvSmpsZkqzNSNYG8EwJkO5BgY8aSJOeQs1RwP142qrvPwiyqqAJ2dM2wy8reGZnrhOu6AMj81ydRVpmO84yBVhydVVZaz/cYWfFgLq59XROvC6mN2IXsvEDv7+869D6jaC3UwBl6Kc4WYicKqnudAZhNUUYY3NNMInwFyl7SpqE3blWY3LDt4U474zSA0qw3UgOOtnvYY/rFvpqgP1UKdUmfLY7qaiKMAHZc4USrLKSOYhzbUpTIZzohfbIWFMMA1T3KsnUBCAFW5DYZyIEWLQz4IQhLwp46KeGkybEhpNDgAJ7lnI6iL44wgjgo3roqBKkWgO2VkKrdE3DCouWNikQt6XVYcgR9AfJ0dbMZ9Op4kI14mx2aDhdYMPVxeXv91c9okHs4FhKdaSx6hWpUnrcjlsUDS1vJiv46PjH5KT5E3Yq4zzaF3Hnpcsk2u46PxsepHQppI8ng2qQmDrWjSBmjdT4J5PTuIqi3OAhlmH+8lZgG0zxwCQhPl8JBzc2WKxoGMsVBsmFwZO2IC2OMeWXZOGxyM1V34Rvezfkp1Ejr0w9NqNbZp6feSgdlP5J2m7A+/6jjrWqPktWhpJLFZM6Xcqfp7y3/EfX0wVl1gkCudzXmDR1SIj+iiWOoNo+uJqJjyGmdA8kGPLKz3rGLk5HqIv9Eme7WR5S0DELv2uJY83exnahhqpKde0WfwDgMucMw==
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: eJztV81u4zYQfhWCpwSw5WzSU7BYNJtNi7TbIlgn2EMawLQ4lriRSJWk7LiGb32SPlqfpDOkLMt2vMk2uRRoAtgSOf/zzY8XXIJLraq8Mpqf8ptKCg/sSsxL0J6d1T43VjlB1+xgYiz7BWyaC+3dIbsevjlm8OBBO+LucQu/1+D8eyPn/HTBU6PxztOjqKpCpUHM4IsjVQvu0hxKQU9+XgEqN+MvkHqUs2nTpyiVjVEsIxNqMlLpbI+ZqHaistqGt4SdeVaAQH6jgZkJG1WR61xYeW5B4qMSxYgJLdu7szQ1NZJ0rl1u6kKyMbDKmqmSIBO0FJ8rsF6BIz8elfyYg5tsoMW4ANkhHBuDNuudUFwESoYxkOgtPfp8X7auLDg8jS8fYKK0CgHhy2XMlLKk87ZVf4fn+/z/DzkR/ujSVUa7aNzx0RF9vSbW/zW4t8K2EjlEJ2v3jPBdaknKwLFZDhg5G8LXymHKsVUw1gldZ9I9XXDX35oO91qVoLr4cd5ike9Y902Wscuge6LAUjS0KOG1NXwUYyhI+PMr4HMncY8rWwdtI59boA/u9F6pgP+P/ctiv9xpSVul/Wgx3jXtykFaW+Vxbt4u+FmlfgZ6xIwu+HsQFizZGE7uetyLzJGGZ7Uujgwl+mzQKF7VIfGCZPHB9GQQh+WgtXXQ2NgXXZn9shHHyVI7BeuCoZuh/QClYfEa6WqLoOO595U7HQwk3vVFpRKVWZSTKMPJt63kWyPrNDixR8xTEjDUGW0Ge9hdvN425G4d/yH17VgQqyy0kBLxoMcVqcpByKAiAps3SfgjBGwHdmdXl+we5ozCSrlPm+2Eeu1UFHVYTQiTow05IxbVsLKmDYiWD0T/A0g2Uz5H4mASG7EDbXwcpN4KVYQYVCKFwx6DJEu2xJ6yhvHt3NSWwtFH496NEqqlLt4WfBzefjC2FDjs+E+fr3d9S1NwjnlzD5pVwrmVeVFSYzNTmm0YwdoIhmEZijYw4EkTccpbqDwaq5/W2+XFgyirAr46adqW4G0NT3TGTdolZXhiViusSMOUx3GuCEuuripj/fdr/LQQUD+ujzaB18XsVvRaJnbw959/HVLPEWw4A1yOcoYbisDZTrWXQVhREdbYUiN8AsxV2q6kNmGXntW49OBNMek7g9SgMlwKgrN+3mv4w9qVrvtQD3VKlSmPTW8migJ8UOZMoSSrjGQe0lybwmQ4LXqxKRLGBNMww/16CgUBWOFOFIaKGCMG/TwIQcibMi7sqcG0KaHR5ACQ4J6FrC6CP44wItikLgqqFInmkJ2l0Bp9w6DimoVtKuR9VXUIcgT9cXK0E/PZbJaIcJ0Ymw0aXjf4eHl+8evwok88mA0MS7GRPEa1Kk1al6uRg6Kp5cV8HR8df5ecJG/CdmWcR+s69rxsqdxARucH1AvFNtXk8WxQFQLb17IJ1qKZBbd8ehKXWpwGNNY63E9MBGyeOYaBZCwWY+HgxhbLJR1judowxTB8wgbMxZm26p00Qu6pxfLz6Gn/miwlcuyIoeNubdbU8SMHNZ3Kf5W2O/iubqhvjZtfpqWRxGLFjH614ucp/w3/8cVUcaFFonC+4AWWXi0yoo9iqT+IpjuuJ8N9mAzNAzm2utLzjpHbQyL6Qp/k2aMsbwmO2KvfteTxZi9D21YjNWWbtox/ANP3pPs=
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: eJztWM1uGzcQfpUBTzYgrRy7JyMI6jhuoTYojNhGDq4BU7ujXcYrcktyLSuCbn2SPlqfpDPkarWSbCV13UOASIC0Imc4f9/8UHORoUutqrwyWhyLqyqTHuFcziaoPZxazOhbyRKGztVSpwh7lxevDvcBHzxqx1w9YfGPGp1/a7KZOJ6L1Gja8/woq6pUqeTTB58ci5gLlxY4kfzkZxWSUDP6hKmnc9Z1+RBPhREdC2NjoWbllM53qkfCxyqvbZCZwImHEiWdYjSCGYMviKRlc+AKU5cZjBAqa+5VhllCitBzhdYrdKxmFcVdObQriY/pv86GWo5KzDqEI2NIGb1l6VmgBDIxUy48spq7rOysvcOx0ipYKxaLGAxlWe51q8INrTdWnEqbfftWnKSpqcmYb9WQ8OJNVxntooKHBwf89RIJ+ewM3HDZ8sgLL33tvsJ1Q52xMHQwLZC8ZoPr2nNAOVg6oQPJVT5+uSpcdkJxUvvCWIoR7z0eBPdS2ay6yHHeUh3a0u1fQwSGYW2s0LI/tJzg/yHlvRxhyQK+Pgc+dsK3S2A3oBtoD9b0XqIGfff9y/n+GZXzu/v/s/sXW61go7Q+WgxvmjbhMK2t8jRcXc/FSaV+RX6koM7FW5QWLRfCsHLTE17mjiXsUF0Q2YSMNKSKqOoQcckniMH90SBOUINWw0GjWV8t2Vkje4/WBYXWvfcOJwbiNtHVlvAlCu8rdzwYZLTXl5VKVG6l9okygm3YiLE1WZ2G4D1xzJdOIJfmPCY+we7i9qYiNys/X3B/jNhfertFjYwLPaFYVIEyCyIifkXTkT6HjrSFrJPzIdzhDCRRcUjSZkjlnnYvy7qdUG/XzrmFKAYmNY/DPKoSwB8wg6nyBREHleAW9rTxcVjxVqoy+KCSKe73AJM82Tj2GBrG1zNTW3ZHn5R7c5twunRxNRej8OsnYyeShgrxy8fLbdvSFJ0Db+5QQyWdW6oXT2p0BqVhTQloPRiGkpCXgYFWGo9z3EKG8fjyYXXVOHuQk6rEnT29zXpva9zVgJ4gfLRartMuGApjs7z4yDSMXTRfKQadq6vKWP/jCmgtVtTPq6V1hHbBveHmlgn2/v7zr30uQhIupkiTagE0KkoattJC6hxB6gwI/1RiI85CPqi0venYBIYeapo+aacc950halQ5TWnBWD/rNfxhBu7cmnokM1O58lRTprIs0QdhzpQqg8pk4DEttClNTh2kF6skg1GCxindx+6xZKQrGlJDo5EjAqufhUMoN8wkXvNSQ/FVodYGJAXzLOZ1GexxDCYJ47osOaUyUof1nEityTZyKs29VMECQJbpSdlA2XGYHGz5fDqdJjJsJ8bmg4bXDd4PT89+uzjrMw9Fg9xSrgUPOKkzk9YMl2Xac22M8To8OPwhOUpehXHXOE/adfR53nS/hojOdfuZxzVp5mltUJWS6tqicc68aQvX4v4o3iqoMXBf63BvNQeqowUZylzz+Ug6vLLlYsHLlLk2NC5ykLQBVbGNLcsod5M7rrbiNNrUv2TdmJyKYyi+G5cZLv6Rg+tP5XfSdrve+RWXsFHzj8XEZMxi5ZT/zaDPY/E7vemHqeItgojC+lyUlFy1zJk+HssVQDaFctUk7kKTaB7YsOWWnnWU3OwX0Rb+ZMseZXnNgKOy/aYljztPMrQVNlJzfHmw+AdzxlkS
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: eJztV91OIzcUfhXLVyAlExZ6hVarsiytaLcVIqC9oEhxZk5mvMzYru1JyEa565P00fokPceeTDIhWVaUXlQqSODY5//nOycLnoFLrTReasVP+a3JhAd2DWltrVQ5uxLzCpRnvwgVXg5uhm+ODxk8elCOeHrcwu81OP9eZ3N+uuCpVvjm6SiMKWUqSPbgsyMFC+7SAipBJz83gCr1+DOkHuV0LbmOUtkYxbKJtqwm08ik/cah6onMaxs0JuzMsxIEytAKmJ6wkYn058Jm5xYyPEpRjhhyt29naaprJNl4doWuy4yNgRmrpzKDLEFr8WzAegmOfNkpeZeTXTZQYlxCtkE41hptVk/CcREoGcYhky4cfRHyhLHYFYorCw4/h0iwDzCRSoag8OUyZkxa0nvXmnCP9/ti8B9zJPzQozNauWjg8dER/fvn1f7i8t4K2ErkEF2r3TcE7lJlpAwcmxWAMbMhcK0cJh1bhWCdynUO3fMtd/OSRLjX6gW5WT3Okw07QGFfpvZYxy6D/okES1FRooJ/Q8tHMYaSFHx7H3zaSOJ+hesAdvK7VfrBrd4rtfL/eXi9PCyfgNRW2+9s1PsGwByZIz1O1bsFPzPyZ6AjZnfB34OwYM9qX4Sb+x73InekYa8PHIkq9FWjIdzUIfGC+PlgejKIo3PQ2jewKzn9xsJ+1cghw+wUrAt2daP5ASrN4jPS1RbrjRfeG3c6GGT41hdGJjK3QvlEak6udAVcWZ3VaUjmHjHPScDI5uT+HnYXn7cNuV+He0gQHnthFfS2ikS86HFJqgoQWVAR65lTPrSVX0JdPqm0s6tL9gBzJpCKUp02awrB7lSUddhRqAxHHTkjFtWwqqZ1iLYQLPhHyNhM+gKJg0lsxA6U9nGaeitkGWJgRAqHPQZJnmyJPWUN49u5ri2Fo4/GvRsl1D6b5bXg4/DpB20rgXOP//Tp5qlvaQrOMa8fQDEjnFuZFyU1NjOpWMcI1kYwzM3Qp4EBb5qIU95Co9GEvV6vmhePojIlfHXgtCjgbQ3PgGKXdkkZnujVPivSMPBxskuqJVcbo63/fl0/bQnIH9dX3cLbrNmt6LVM7OCvP/48JIgRbDgD3JAKhj0ncMynhVA5hF0VyxqRNJZPKHOZtrupTdilZzVuPfhSTvpOIzXIHPeD4Kyf9xr+sHula9jpoc5M5tIjxs1EWYIPypwuZcaMzpiHtFC61DkOil7EQKoxwRTMcNGeQkkFLHE9CvNEjLEG/TwIwZLXVdzeU41pk0KhyaFAgnsW8roM/jiqEcEmdVlSp2RoDtmJ2KPQNwwqblyIUCHvq67DIseiP06OnsR8NpslIjwn2uaDhtcNPl6eX/w6vOgTD2YDw1J2kseoVzOd1tVqyqBogryYr+Oj4++Sk+RNWLS082jdhj0v2So79bDxHepFwprO8Xg3MKVAqFo2gVk0kH/Hpydxl0XQp4nV+Tq3D/gRIwv0ltgXi7FwcGvL5ZKusSttmE0YJWFDacVJtYJImhQPhKT8PLrWvyEjiRyBLwDr1i5NwB45CFuM/yrt5mi7uiV4GjffRiudEYsVM3IN/57y3/AXP2gT11ckCvcLXmKH1SIn+iiWYEA0ILgeAA9hADQHcmz1pOYbRm7PgugL/SXPdrK8papDSH7XkseXvQwtekZqSjTtDn8DvdmXLg==
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: eJzlW+tz27gR/1cw/FJ7Kr/tpPF0OtXZzsW59KyJ7bidxGNBJCQhpggeQUpWPf7fu7sASPAhW87d9EN7cxNLFB67i8Xubx98DCKhw0ymuVRJcBz0w1CkuWacZSIUci4iFmYiEkkuecxkwvKpYFMVRyL7k2YLHsci32ZX8NB8ZuGUJxOhaZw3U+c8L+CpYsPq6R2n3UQ0ZDyJmBZJBDsn7OL89PDLyTlLVC7HMuRIG07FNaXWhchwS6mZSkVmfp1yDcOB6N8KoXM2UtFyO+gF5YDzCJgLVTKWE8PiqZzInMc3RPVFKmDESUkYzEx5xmciF5kOjr8+NqR0nUjYh0kaPpYiY2oMIqvxq+DLKoHB+hLXSXk+hc8J7ITkldOB2l6AvEh4FBznWSF6gQ6nYsaD48cgX6Y4XueZTCbB09MtDtapSrTQ+Pv+7i7+qdN8VdLBnNgbh4RkgYhy+IbTeZrGVvg73zWu8dimQY2+izBHeWUo61waCqpFaaU4vhiTGJuz6iRWB4DapzIkkOeeBJ2SkXR1Te94vOBLDfPyIks0E3ORLRkcTRxts775YFazmjLnMZ6gmwHCWMh8yiTovpil+dIMOGbDb8G3YMjGCsTGjMR7bLjrniTFbCQyeDLmsRbu6UipWIAio1YPkyKO7Q8JM5wz84VnGSc1rQtPRu1DboqqUwMbd87I0F4VIwEUo7mbGnTOCgEEMvR1b7gdPPXq2vgD9CDDLSPw7KWobXr2YCzJOpufPycFYRcypw+SjoqQVB+E4ut+bfcrdS+SlzdG/cv4gn28ueqxy9Mt+gt8z05VCAYL1nAEkdmK2BeRAZ18FAvmKTvXlbUdZ2rmGToQDxmnU5Jn53TNzmEoT0LBNqzl3PRXP0uiVMmkKeCuS8yjSCJrPB54GmnMT53zU9CtCMhN+TJWPHJsdvNHkthmJ2BbuEyM/oF91ehcYi5nuuL65uCEfTlhGyDJzR47P7t6b+UKT0m055cXbO8vu3sHW0ck5p3Z6Sf/HMkmGGWHA7aXbzGVsaD1rbVYcLzobRVtyOiSvFaXHgi4+GDRAvQx47HI7jRaTffFnSY8IN7vzPEH/tqdz+CoI7NBzUveN8c5C15/GgngjR5KqxHwKJHw5LZlaossg1nOL7evzSpX33e32BubqGwGPy+teVGJMAtmwpoYMNXDNpdDNgMj2YIKiRCwyAw2ga1Eqnt0TuKBz1I4RM7yDCbxkNw+KiEZUxYCAQ4jOPxwKuAwkNau29AAIveIQip6rJ6U15LwiWG8oTErAE211AtOlxRWwcPMygqYAtNcswN0uWM5FuEyRBkAMSH6jzQVPPO0u7R1oPpwgGDsJuAnNWm12R9XWtO49csJ1pRteJK/k2THS3tTelE8q8jJ3dFe89SFJngoCQ2mCo8Nfnz2rJB+t6h7uIZP+vzJKfZ6GjEAYeGl6Oah4RTJPL9MhLeRmcI8bwWGH/aRifCFCcJapjKkC1VzBCOuBUOmCrScOaJdreK5Ofr2Pv8QOY94zonwNBP9Ip+qTMLcE7g1L1MO0tjiZs6/8b7jVSu10ruvZPLqwvNFjsv0q2Vwb/Y+VgsiCzjJBnIdT9u89Bv5wx1+2GQOJ79uZ2CAw23s+3oESiAmcKgd4OaB5XIGkQUYIbYBZ6XB/0G0sgmXTyRNMOHQ64LTU9wHUZ41YcHx3tujXfMfiiCN/iuExBziopmKUPM6yXlD5Biv9Dpq2EaTCqe1Dve0A43u3RUFYhfZhCdSl4HbD4NhC52Utx7biEzk58xRJNJYLWcwddMGCBYjt/Gh+qPoqhH0wqb2inwuo8FyVxtltLa9wTMYImob9nwPNCs0AeA5ENTlR6srBbYFnFCKaGKtG8XIpbDPJvpuWMr3iA46zbUHoubhn3W09X2BGGqeVp8j7zn8ezcP7ygWdd/gw0yru1mkwjbIMTs7oXclNFYY4KG3lclN2CfwJauDVLQ6sAmglGHJwxC/pNUXWqDkxKxRh7bVKjTWsTRER460d6JeM6eBeE3wWgB7sQ9k7hO1MEvZWdYpoMleW589zxXL5B6GtAwOaA5n/rolJukxOfbwlMYIIDd5k2iZ8JkMK6gzRp2SyRy8G27SHQEN/F02zJjDL4NNYk023fOKlMOp1GnMl7CZkQuuxUeqyFt4mBbsOZ/rBWqrPW8t+MueS1fQwYBgzDmCGlAywpylOQxtTKvMEfklKq85/1np6v200VeTWOoFsTJpHMrvzMmSx2qiGsK4beYhTFrqJaVwEsTRDYbxIMq9X1zokx3ZsYih+jWArwRNNJXJGZ8ISw8w/kMr4UxvodqEF4VUfWux91SzlieUoyxM1lL/viDd08zQX/b1umucFGUEhTZhVt1TkW7fiyUG1THeXt9tOPW0tqce0IHZJIMJ5g45xY+1kBasM7Fr7XBk1M3kqPKHBpRdccvb6HFofd1wk1WZXpZzdGOldBz9npQuDNgtuQXvzHQC0+BawseRCDk+gtlLNpNZ1oCkC7iZNbtdxpnGDgwfvwWxSCb59FtwzHZ77Bugr7TI7wC4CXyE2Uh86vHnHj8NK/RFmNylOpuOvp1xNFuuAfl+pXQn6gYY9QzWJKm5JG0LUQABhs0y24qZ0/WpLEHiIZr0UhBreCoci3o3VVVc0Nyht9L9Ay4BP4Pe3pZDCDNiZiNews+5eMir33icgoMzMzyx1M7XJKyJCiOKUmb2frnaR8QiJVAeWEkR4T0Y/IYEjVP4ARkGlsZXG6/zBH4ozKpOlhZSEhviAW4k5vWmeO8Vm4hudUBbV/dPVu9qZ9twSpi5sIiTbNcp2BIZ+4aRsujt7IU/CU6ZZrXEXqYtbLrL3VOHZ01RpTup6ESxOswEvnIx6zTidWIvcD7b395lvINsE+/jdo68Bi5BzNRU5s/vT9i7g3dv/hhb1bIYhp8XU0hd3OCUplXAuE9GdxVfZcHkGZZdta+u5a2l6tHIXc0T3q1Ta3m2vFB3rFaN1oaENcoHU5WrWhmyTnkVR3apf1PVXHXwGVDgLfi7boYzcmTDyuwvoHOX0WyLpQoVGyaBqH/+wFYK5dYsNrdAcnX2vjsXXs20aXEw9ReugIwqaXK6wJOMAKV8huFe1hgGzngC68QYTdAgzOvAwMtCY8bbywqDDVcZz2R9aGckVxp6K+QEK5vGN9i8iqGViiPlYE9BS3+iixR29dncrsfgHq/wzbIHn0r6yRrHYgLIU0b9PMc01JrYHiexARwSCNfdJyvrjU+D89NNxqv16tlFTyt7ZepzjnFgIz9KlFmlzpdO6c6uT8+ZKfMzESq91CB+Ewq0ORmodJ3EqAKq4P+B0lpoTUwM1GCzdAklSciaz1nP5F8ocC6vGtbcMxUbeMC1VqFEdYChcg4f0HjX6DUx8FqpoPMkQjELih6pxvAseYQjRgKUSBeAbrQeF5iFntsNTR2hyJUNvX8kF+XiX1gFw22T5rYJg1YCzCg0ZzAynFaZAIjyWd21WHNi6vkmxUDEAuV6LQX9YgY26wWlq4Fjy1WoPF/cGQGBA+ZFTHQMo4yP87u9g6F/zSxBd7t7dJnCbJnmapLxdCrDX8SycjUvkwzD/dTixvBeRhDOWA60nCQoMac8zZ1WZ+Wey6F5qx5jLBYdw6chmp7hw9Huu2HDotgB8Al/JY4BLKKpr1wBOZTf49D6OB4JBC2aS1VotKom7VxLTOE2rgVkjrUyIoSE0yJqHXrWCMhX0xrZ+rnd2afUltRN1c66Rn2W0AHWdXntS1f6dLMYE2Y12LcjxHW+XXequUmuORN0I/PpVVbo/JPUP2QOLGWkXo2rD6bIGR7GJxhg5FjntWgA3QBuzGJpM8709VJkcxmKgclydyYAX9PkYKIGq/xmP212cIn0DISZZ0ujWGSnrFu2nEVFRua+pNUyZT3winaFus8fqwICQ4jvaH1TikD7h1HGyze4Ci4orVoasA5EDYBnnIE3woxtIoASqtWOMrXQpD4RaE9Iue4RD+/ro1AuItvK1Zb5hBWEWZF0M2qwzToRlGdNfNLgq0dCO0y0DuE10qmHXq6TEDOBjs66z6nXE6U2GOM6kXk3NFrzTtRvgcRWTItecGnmrc02bq77m5Q0QHyHLZuTIuZZzSt9Fs1wSVP9gWaYDj9MpgOkkuYa+U2X6xQFhv4EgOPDZgtTryrMWu8N9uZXv7WzVuf3l1u/1t+5Xkcm2V/9cj0IY46GgTO38KkKd0zE9Eybqmu80Jrc3NVaUTOOcqSbybYBo1OwZR51JOBcM+OMTwGOmhQpSCL9uLh/OQfx8fLiV3YjRgxxxcbHm1+wsm6BmQOsZTdQWoxAcxAGEA24HRtJ6upp5wp4PFkjVRBP4Grl0xnD3CNGG7QyJiioFpJPLRD2I+azy/2jNwbdzNdpxfAgEAsLsFKNAHzLLne/TloA5QTw2UUkZJuxRzQVIapDm1ojvS0rp6298cHB3oEYv+P83SH9FbuHu7v8bbg3frPLw63R0ZEI+buj8N3h/uHRaDzaGx2O9g/E2/3R0dto/4AozZfrUUpZl7rwTnCBh5en/xNMucqAZgxG3F0+O/GVYOMnrsWbQzSWgC0Q2WzWNxvz6w+nR/35m/H5YHBZfLhcqrNFeL3X/+de8dNdJkf/ePMu+/B+dPmXPlK1BlP/+gOomhz+sv/zfHchJx9mg+838u3+4Sjrv/9tcvcQi1/y/Obh/dFR3P/56vKwlahAyRvFQyEiybfNIY1cxXn9q9fh2m49rXVqdrQktvu5OjqkOvqVujqBqjYcvy3G70xZ0ZjR6ohodyt0NAK06s5ltfaZOlhZ61mRDu7I+3SnKlaG/R3xdT3YraJJizX7SQiEBMZcrI5sOsOLTmS/GlmvQLc+DlwBgFYjk9unVsPEtTnx7iZyr1g1BrqnwtRDbO0agd2wqaYAaBZga8l6J0xPsQehs11ym51Rw77pg2z2qjdKJrapacojNhJj7BM1T8uMIpVUp4JHJlOK3w7NKxFrv97gX2OBqXGrfPTZq+Zi1fz5VyGq2V3ltarCRf1PreW7umZK8/UTx/QsVrrKGqbjvt2nXus5kiYlaFOZjYwhODX4vUiwZyShvGIthhwbj9cAPtvsgykJla/cGJwJyq4M2JzDRSWsad+lANw6Ug81utA6N89t7//43K6TqgGzJZqj/2uVPof9sgRfKjHRJm3TkBFM0gJwnkSQ9PUx6KcSoBB8hHDxMfiJ8DLaT3qCXPMJvu0V2HfDXNxV9hadbMIGRs1RSKa8DLQAuSgjfJnrONiZ7++YJMWO7TTcMnZzx1SmdnT0fZHvVPdt59GHCE87xigGSDty1vX+2amYKcs4+twsRnSZ56k+3tmJ4LctnsptCUgXYiqpAuS2lcKObEV3xTIvrQAGfoJhwYrp2vzcJOS2OpFLVEyjT+5cqpSbeWDfkjNHGpTvydXC8HYgMTgn8Ic3B4Xq5x+MI7Gh1bC2zpCZbUyX5AjzO2IsH9x7YUNDIxuyDTBmwtW3ZUwySHkoNntMbE+2G8seMzvxr0tVZCiOLSDubyY28zXwMTDxm8vLBh9vrtq8+dFgyrV25JmVLM1Y+ainKkoJkjWgYJcmBOVNx3MjiIuNcM6s8JDMCtgPiWdrC0h/r86zPBL5c/Worgi+DjW4KSe5XJqm/J7tO5X4d1Y2+NU7el/3MhRmSF7XQ1jm+7V9fQ61SiQ4R1uP9W/r5DBzgq6xR4DFNHDa6pTrNA498gpNGgPAPeJZpLeIX8mxcT5GeETH6Up1SO3zb0Thbi+8EuV6S9G5gnsASCqq7j64exx0AhNgraNbLBbbnH7eBpZ37Fy98+n85OzXy7MtnIN5V5nHNR0gYUUqLMrT87DzcbC/u3+4fbC9Rx2oSucznvj0kPVjtein0a1Serz/tbeV7V3E9qIdaqmh/u+MXtUz3uVrMN8PevZFZiqw+B7GxmkUjZCXaYaRx41g1LoasMpThcnSr8HjI75lcp3FT0/4GOjLyGHCAfKM7oxxRwDY4DM4P3rv9Zkj2nCh4Cb7A96a7pSQcxoJegwy8fANwzL0KfX4++m2jAyIDzOk7zyum9wCUk++ux9cX9loq+6yTKXLfvDedq4T1vRehgT8F51s55S/4oUCJ/K3crj5ZeWE0t6b0SimW4BD/wHH3Y/G
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: eJztO2tT20i2f6XLXy7UNW9INtTW1iVAJmSygQow7K2Ewm2pbXeQ1Vq1ZOOl+O97Tp9uqVuSwWRS98veqSkiS/0471effuzFQke5zAqp0t5h71ilIzkuc6HZfCKKicgZZ1EuYpEWkidMT1SZxGwoGC8LNeWFjHiSLFgGM2CIiHFaCnPgUzSR6ZidZyI9O9n/44IdlcVE5fJfHPdiX8U/S6ELJjXLRSTkTMSb7Goi2BwWFAXjWZZIAANgYJpP4Y8oClywUOZdLhKO+9XA4Vhe1BOk1iVPI4FDcGifDcsC5hVlnmqmUgAbx3rYmfkLVbIxn8H81HzPeDHZ7PV7KhO5Af0sBkJFhlAVuQA3dUE0+KDyEzmWBU9uDCaGAPFxtQsslfEcACxErnuH3x4bLLhOJVCGSTN8JIEDatRgQqHgh4NvopJY5P+lLeEQVInrINzwnMJOCG81HcDv93KgvoRXvcMiL0W/p6OJmPLe4WOvWGQ4Xhc5ELv39HRLg4FV71W8wBEhuF/EvJYFJwfEYsexkcoblN7sAAEoWsBX3MHwPjKLbP3QuM1jG0I1/CGiAqmZI2sKEBYzt+aEN3ioVCJ4CqND6G9QWgcIwKBvYLTSZ/FAkQIB9Wgfir0EzqQvirjRBRBlWWwy2nAE0up2JP6xaamN0OcKRE/waBLQEgkmHvg0SwTR6+nJp+C3AO3bpyf6rDOVaiLL7vZ2m3eeummQ+NjAk77IUATmF3GrpqxZKUnOR0YlmrMaVqrmB9gOlce15ltqOqxQU3RoV5I5X+jKDIiZyBcM1CwB83NED7TahGuWKjbjCWqjm4EWThYT4CXMnWbFggYcssH33vfewMg6Z6Q9fTbYdm/ScjoUed+x3r61YglCFLNBWiaJ/ZAywpzRD57nfLHZIp6M2wrbJFWnNWmYPaIhUgnQJAogGT3bS0QAggx8OzLY7IGYBZblJ+BpW4eXDFyw6elDNOHpWKyy+dlzVBB2IeI+UDouI6MSgQFo7H6l7kX68sYofzmfs083V312ebJh/gW8pycqAocGaziA0GnBrn+IHODkw0QwT9h57SvZKFfTegaSh8yQoWfndM3OnEdcO0d7dXy27q9+msaZkmmTwF1KzONYImo8ufAkkux4iPkJyFYM4GZ8kSgeOzS78TOU2GTgVQsuU23db67RzSdcTnWN9c3eMfvjmK0BJdf77Oz06oOlK7w1pD27PGc7f9ne2ds4MGTemp589vlobAIJOzDYKt98IhPh+4E5R0XvcmABjS7BQJa6Sw4EKD7aZwwgRiOR3xkL7X44bsILg/sdsb/nr935Dlgd0wbeSx7dN8fxKBJZ0XwbC8DNvHQxErxKJby5bZnaMs9hFqgkYtihNkuUFGyp1WJvbKryqfGbZF5UKmjBXFgTA6Z60MZywKZgJHVz51QIWGQKm8BWItN9wyfrJcG4FjlM4pHxXCiExpgydNwuhrRawE4EMANh7dKGACJDYh8eKyeVWqIlt4g3JKaxDvHFX8q6LvepNR8FVpmQnGgFSIFpDuyAUe5EjkS0iJAGAEyE/iPLBM896a5sHYg+MBCM3Rj8pDZSTfvjSisat6NqgjVlax7l76Sx45W9qbwo8ip2dHewB5661MLGX8CuTCHb4OOzvEL43aLu5Qo+6etnJ9irSYQNtJbg0HCKxjy/DIS3EU1hnrcCww/7yFT4xARiLTIbiAaOYMi1YIhUiZYTiAfgqmRGrG/v83dR8JgX3ACemVwGg1iYewxa8zLkQI0NbgNf1HdUtUoqPX01Ji8knk9yXOaoXgb3Zh8SNTdgASb5hVzF0zaVfq14uMMHFD0Kl1+3s00ej3w5AiEQY2BqR3DzwAo5haAfjBBbkxgyQ6Qc63XKi5vZhI1e51y7JDUI9HfeHmzTf0iCLP4/ASThmLKoGCWvE5w3BhzySq+Dhq01oXBS6+KedprYvbsySfV5Puap1FVW/tPBsA2dlLceW4spi3fmKBZZohZTmLpuEwQbI7fjQ/Wr4AoAemFTqyJfq6Tw9cmvn4piIgoAdfnRWqXAtoATyjCaWEmjmHEpLjFuWMoPGB10mmsviJpF/63jjR9zjKFmWf0ce+/h790sujO5qPsFD1Ot7qaxitpBDu3siF75cj/t7zbAA2+rAWVx9AZ+5GGQilYHNoEoZVDhMMAfWf3DLFBhQmuEoW29ihnrUBqgI0fYO6NemtOIeCl5LQG9xA9k7lM1p6XsLOsUqiLAK/OsRKb3pmrXMDggOTwsLriYpI9VlTqe0pgBFFQDixcpn8qoDnVGKFMynYF3q2uNzQzowt9lrSrWrBvUZNM9Lyk5nEidJXwBmxFdcC0+VGXRiofNgn3nc71EbbnnDZK//LlyhWEMEIb4CGJgihHES2KGJtMqC4z8UlUEzn9aufqwemSKhP1eoqiMY+o7M2PJEzVWDWLcNusQVGJ8SSgcBXF0A2FkRLX3iwt9tiM7FiGoXxPwVUGTmcrklI+FhQcQ/6mVcKa3UDDhRSLVv1roPQXW0pWeDSn0n0vSPcmM/GVfL7vkpKravWp5KiPb92KBSXWC2uu7DSee1vaECR2YTWMwwdwhpvgYpLRgnQ261g7HJG5UoyoeGqHsEi1vR48D6+sG66yu2rOCoxurqOPg96h0TsFuhS14Z6ZTmAZqCY9DEXF8BbMXbCrzvBGSzkEzA7td5ZlkBwaP33uJSMfF5HvvkG332XeIvrKyuIPATeArrEbiWw8/9/ppUEdfJiZ3pc6mo29XHGnLFUK+L6bcibIBRj2HNQ3VXJG2FVEAAIRmVW3FyunqUFZB4j6a9IoQK3gqHItyN1F1XtDcob/U/UNcAn4Gvb3JgWEUxox0uASfC/FQ1N94koGDoxkeWQL+UsHaQEGkqGhm9Qs8GcR/KOGxEkgPsPMTEd2bw4WAguQUfoKGPQvjq43XWQofSlrV0dKGlAYN8QAaiXW9Ceq9YmPRLQ5o60L/ZOUu4G3DKWHlwj99OQFbIhPfMJoqert6ERzZxDSrRfaqbGHLXU5PXTxLJy3dRUVHiuVpJuBViGmnEQ+BPcf5bHdzm/EOsCnfx+0ceI24BGOmpjB//XDM3u29e/NrbFXLYhA+L5aQurDBKU2rgHmfjO9qvKoDk2dQZrnLN3wpby0VZiN3gSe8W+Ws5dnjhdCxWjFaOSQMIL+YqEIFR8oh5HUe2SX+TVFzJ73PBAXegn9KM5yRMzasqv5CdO4qmm2y1KliwyQY6J9n2FKi3NJiMxtILq/ed9fC65m2LA6m/tx1B6BIUk0XcJIxRClfYbhXNYaBU57COnh+nJpB1J0wuCw1Vry9qjDYcJXzXIZDOzO5ytBbIqd4skm+wdZVCFZzOFIN9gS08ie6zGBXH83NMAf3cIVfFj14quA31jgRY4g8ZXxUFFiGWjG2x0nsApgExHX6ZGm99vni7GSd8Xq9sLroSWW/Kn3OMA9s1EcNZFaoi4UTutPrkzNGLRtMREovNJCfUoE2JhcqW6UwqgAq+P9CaS20NkhcqIv1yiVUICFqPmZ9qr+YxLlSNTxzz1VC4QHXWkXStMBkuZzBAxrvAF7KgVcqBZ2lMZLZa/t5FjwTRwwFCJEuIbrRelRiFXpmN6RzhF/SiNHZZtRuy/gzXUcILECuVxLQP2hg87ygcjXAtkJFyvPFnRkQOGBeJgaOQZzzUXG3szfw1cwCdLe9Y5QpyhdZocY5zyYy+l0salfzMsgw3C8trg3uZQzpjMVAy3GKFHPC09xpeVXuuRqat+oh5mLxITwN0PQMHg623w0aFsUOgCf8ajCGYBFNfe0KjEP5Mw7tCMcjgCBFM6lKjVaVys5BYQq3cS0g2ItDgBjitIBaBZ4VEvLlsMb2/Nzu7ENqj9Tp1M66Rn2aGgaGsryy0lU+nRZjglaDfTtSXOfbdaeYU3HNmaAbWUyu8lIXn6X+KXNgITPi1VB9MEXO8DA+xgSjwHNe15oHbgA3Zom0FWfz81LkMxmJC6pydxYAX9PkQFmDFX7aT9MOrpCeAzGLfEGCRR1hsY9ZXObG3FewWqSsB17SrhD6/JEqITGE/M6sT0cRaP8wy3hZg+vkwpRVKwPWEVFDwDPKwRthxTYVAIk5qx3maq6N+MQgPZGpdQ95dB+OQrqIfKNQG/SEJwjTMu1GlGKbVTIoz5r4oMFPD4R2mmgdwmuoE6ZeNrcw560OztDnhOeJUlOMcZ3Kojs0WlEnQi2AX9xFL7g089ZmazfXR+umaIDxHQeYx2XC88ArfRXNdEmb8wczgzr8sJgOIZUkNYIPlXiucigw8CdAOD5otjD164NZ673B3nzxJoXn/P5yq5/1d67XUUn2V79cLYQh1jBw5jZ8qtMdypj8NV0LirclN5GUcXNXK2XNOMqBTpNtA0YnYas66lAAX3NyxicQjlKJFCiRfZrfv1yD+HR5/oXdiCHDuGLt083veLJuAzMXsFbdQFk5BMnBMMDAgNuxoTRdPe1aAU/GK5QKkjGoVjGZMqw9YrZhVsYChTkLKSY2EPYz5tPL3YM3FN3MVmnF8EIgFpVgpRoJ+IZd7n6VsgDSCcJnl5EY24w9opmIUBza0BL1NiydNnZGe3s7e2L0jvN3++Zfsb2/vc3fRjujN9s82hgeHIiIvzuI3u3v7h8MR8Od4f5wd0+83R0evI139wykxWI1SE3VJSTeMS7w8PL0f4ApVznAjMmI0+XTY18I1t5zLd7so7GE2AIjm/VwsxG//nhycDR7Mzq7uLgsP14u1Ok8ut45+sdO+f4ul8O/v3mXf/wwvPzLEUK1AlL/+wugGu//vvvbbHsuxx+nFz9u5Nvd/WF+9OGf47uHRPxeFDcPHw4OkqPfri73W4UKpDwJHhIRQb5tDmnUKs7Cn16Ha7v1NOjU7GhJbPdzdXRIdfQrdXUC1W04fluM35mypDGj1RHR7lboaARonTtXp7XPnINVZz1LysEddZ/uUsXStL8jvw6T3TqbtLHmURoBID0yF8szm870ojOyXx5ZL4lu/ThwSQC0PDK5fWo1TFwTx7ubyL3DqhHAjTcfqss2FNgNPHINNtmp6cGn1sZm+3njFMT2KU043kEaYesnva2KhOaUdCJ4TMVP/LVPVx9WvrHga6bAareVJ/PsHdDiQfjztxvq2V0nZvWhlWlpai3f1QhTWaT3HCuueHhVHUs67Nut50EbkaQqn61ONoqA4Kfge5liG0hqSoWmbQBCR14od1Ei5B9OmIJioktnH+m4p7orRTEkCLKiQHIGSmjiSHtPAhYeqocAQLS8TQbu/Acz8DqtmytbpDn4j5btM9gvT/HCCGWSZpsGjWCSFhDDSQyAvj32jjIJYQ48Qir42HtvYmG0jeYNYs3HeCuvZ+/wuZyq6hs6XocNSMyRSHR0DLAAuEgjvHR32Nua7W5RAWLLdhFukE3colOnLR3/mBdbteJtPfru/2mrql70EHxEruuq4ImYKos7utQ8weCxKDJ9uLUVw7cNnslNCYEspExS9RDhVoU6tge2S5Z5aQXwoWOM+pdM1/S5CchtzZRLlE0SKceauqJGL+yFRuJqr7rSGGTZ7Tzh4szEdqg8SFe/vEBOxWZOg2CdAaNtqAlyiOUbMZIP7trXgGBkA7YG9ky442uZGBpkPBLrfSY2wRKGyx4yO/GvC1XmSI4NAO5vlHr5QvjYo/TMlV17n26u2rj5yV7GtXbg0UoWZjzYCCsRFQWNQTC5rJnQq5Qd+WYiWDQdX+t7n6dOORsXLG3xErvinB3ikbFDYHAkSoI9TfqfmvsVA+Vv9atQbHyJa+BeTXKFNW2KfbYJVeK/06rbL2zvfd3NKCyXvK6hsCr+a3uXDmVQpDhHWxf3L+sVsYyCsWzfhDrUzWmPqlzbsX+xudRGvgr0w3msNwy+kmMXfYL9mob57twOoX3+ehTu9sL9KNdoit4Y/AnEp6Ju9QNN5SBBWA1rsW4+n29y83kTUN6yc/XW57Pj0y+Xpxs4B4uwskgCGTDEilVUVtzzAunD3u727v7m3uaOaUdVuoCQxIOnuodtzovCvtL25a2mPnn+8/8vwC+/AG9NBDY1bZlGHtN1npsLguT3vvVmu72+vRtvjnV832ezQ5MDGf/XTF4Pmylw5QTBX0wUVmm/9R4f8XrLdZ48PeFroGFuvDkIC8+NfpKjhGgSnsEzmwu3z3B8zeWg6+wXXL3vJJJzZyn6MuN84Bfmg+jtwsT/6bbKXwweNOSYoN24oqYHt0Qr1kP/TDPoUtazY/3o5eIavczQ3vCn3rlezjFbxL+HPWwcNAykNBtDSW7OFBKejks+xvG07JMtsYd+nE737IN3wzukSdOlEy74FzHrnPJXtBvgWf9WDacvSydUTpBGI4fwwvy/AWXls0k=
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 API key
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-api-key

---
id: config-create-digital-wallet-open-id-api-key
title: "Create API key"
description: "Creates an API key for the organisation. Use the key to call the OID4VCI and OpenID4VP endpoints from a server, in place of a bearer access token. Send the key as `Authorization: ApiKey <apiKey>`."
sidebar_label: "Create API key"
hide_title: true
hide_table_of_contents: true
api: eJztWv9z0zgW/1c0/glm0iRtgYOys7OQFi4cSzvbFDigM1FsJdHWtnyS3JDt9H+/955kR06ckjk45m5gd3ab2NLT+/p5H0m5iRJhYi0LK1UeHUUDLbgVhvGcPTsbsiuxZFOlmZ0LpvSM59JwHNllF0bQUxxhFYt5mtL30+Hxg7eDIQhI2Gkhcvx6xkSeFErm1rCpVhnjzAh9LXSHyZwVKY9B+hSeTgTXQjMex8IYEHslYKVzmFwvxQ0bPyvtXGn5F2lyxJ4V8h/w5hdOf38ddz/ln/KX8jrQD/6aWBVgl51zy6RluRCJ6bIRvBnHKp/K2dgNYfBfbmiKe15qWicwAVTF14mcSctTtgDThe0wU8Zz1C/WIhG5lfAqEVOZS5xuOqzQwsBzJ63xZiEmc6WuDDkNFPaKoY8kuEaLaWkoJstKR1gfgwJRqrTvsDEvE2nxg584JnljlU8U18mYLaSds7+PRmfsQb9PXsJVQKsCtBBsrtLEGU6Ox9BMyzSlGOHTsXPwmE2lSBNUURom3QyVp0uWqQzsY+DgxVyCL5aqhLzIwY/FEn3uQx9TitXrguMUGC0KHAJLQW7wqXBZ4ZRUbCKDFIBswzF5MlGfG0kJs40VPKkClHEQV0enyiJJwQEbdDVuiyxntH95qmfDxJtezZuoZOnd4J6Hzlhw0pQ05y51rTMdpD91st/vnTekz0F5UGsOSZQrJqZTEVuQBoNBMsRd+9obbVM6K42FIkpVPsPFIQC6OQATwg+CFCxStRRJN+pEtfBhAiDgUspBwbHL8nfkRiroxBUczNLiX6Uw9jn4ITq6WUMSVLKCEAQIktb1syTUSHRkdSk6uJqFkKAEXhSpjEmR3p8GxdxEJp6LjOMnuywECFaTP8EvDUEfI5eb0WUnKjQaY6UwTiI931279UWstKmogdGZ/kJp54k1JRzGbCqR80wEBhirZT6DuU2V3sCoKrW8ag5moS5ARSsAYSmiiBCMF1xbVFh85llBKp5plZSxy15jSp7HVDDRbafSbKUD15ovN1Q4dyC5rsQJh2oO0ZGzmVZlgQNrWNyOWQ6trnlaijUMIvNq/K0aTXsL2YLG6AJpRWbaHCzyMsPAuLnwgCAS/no1MfMdOkaXt4ErgxnVSPe+kHo5zI/5MlwO1BAzoTe8+VpOhZUbQUVoSUBCB0wqYWrigJEQyyEojK+QoulVculhn6YDyAJII8amglOzq3FIlQB44Mx6BIHfuD/Ghxx63wxkwxQKSZf0nvIyhRI87AdeOOxj5gQI9eUcHu4GrjaA9FUVdtlrb4lYM4T0h04issJCD6S1Ow0pvo7XYL9Sokldvi18PmVyiiWaKIGwDQrbIGIz8LNZJXyjXh89fvxE7PMH8cPJwfSw3+/v88Pkb/v96Bb/CUaGMOawZGutr0q9LYfXUxgi7JaqmjGl9UG/3w6YlVEOLZMmSIwaTQoAwJYaoAKEddAt8GHf860Gj6hC5MaDUIe8ARsxcobPHRuM/hf6BXJIu+mPu9rH3Y1D4gOKbB2/TqXKWsxQZAZNF1KjfjUKnpAC4CSn0vMWE+UOdXyRS2jtLVypCvcOiXzQx87zFb0vTLmquhhEN75yYOc6CnaNktTNYdPw/94Rv2M3W6X63bEZrWrw1fnpG/ZOTNgo2JoB9u2yKyNnuJ1FUNvk3s4GSG8+YTzJYMcEOnKLXSxPOq6/VegPCTGBfpps3x90tjakZtaI5av55GUsT+Wr4cVfw/03cmiG+R8P48Hw0fCqeP928OpJFwaN/nnwZPHh/e/yNDUSPpcfsjQfpv1utxt9R7bQgkTYM1MOfaoskhqpN2qqnU18BVdYIVNLUkGdZhymRajRHg7dcMHvzqA6rJWiZMpCKytCz9DG9GI0aBplhDUhPEDm+A0nNm9kjtdCL71jUEScQhVhw8ctvQDSIIKtViMvDvoHj/b6j/f6T0b7/aP9h2D0h1WgR9/Y+Cr+JB1rxFvbotIT0Kqpklv/i5W9LNpRN4U6a+nltLGl3QdOwsljOdMcWoQa05YW2DzX9bmLP22hYwAXAsI6Ck6NlvUqDro9xFViEeRkAZToMrS6fvtf46dVh6+LcAUuzkP1hp9PTCNsONpRSLMrId2RFIZNvYXdbII21DfuAVQbX+tQOeyy58CjGV9RAPOpmrFMWA55zJubec9igHvJFMNm/zPmsRmhu8xwqrpKl2Z9i0DcwB2+VHMpA1eHmzv4/pEg3zu7vqj+CQ6DXpVoPMHcxYKGBtTkfvPfu7HKcGluvw5SgtDehSLrwHZ71zYEQ7md93W+dptSLfRNevHmrqfRqtrNb4H1drStOX+AWY1C3e4qTK06s1pi70J/R3g6kTsyxOrCbw/czm3nHVJYvUJrpQcqwTSiz8dBLl1u7myapb2a3cZ06hQCBW9bxLeR3To7n3MA2rwoLSu4hrSyINJbv4l5/kgSwUDmgAsyWWfhrpURnkFcbempT70rBcgYu+Qco5QM8pZOG9yo6o2jsLwiGTuex6Ps6jg+oK+tPQiqdu3wud4Dic/Qn1cnPNSt2g+x3fjwpHc9YfZ/4IS5yLnftIikxTWHP7BrsGbwTm91HQEKUi1AWrmD2uadxClyQ8j/O/ZseBeU8ZzP6uZnnoYXjfCedvgVXXdVFfTJZoAe/tBgN4T1dM5Tf5PKaJk1HyE9FnGppYVG9PEmek7Xq7hRh6+Xt2gnn1EP9rc8zF3zsHvVsfvgPojECPjDMlBorrCfFcqQXzjKinrXBz2Hez0KeQ/A1Ld50s7Q8k0DjkWmvPIwrtTYAufWFuao10vg3R7I6Lqe2iWqvy4g4BZbxHxJwjmYjzRxy3TjXq8rcrny6jkml8uJZ+unKfXxncSlXFhWxKhxWrJB3KqKQHhCOhwHvNx3HMcsm6cu9Q1idUZdaDGVnyvaO/ZnMmN2L6/20lCaMiUfFDwW9ztMdGfdrYc5eCKO7ti7oiMdJKdhTt1E7gL/RUVNX70bbdoWXO5DkhtTqeckeZ2RpzaUYLUHqaLRh26xFQHDuEWY9Fj7f6zuJk++wzn6+kb0rsN9TImpqrCLx4RdFQs0ZVEobX9bJVydM/Ll6lEzU8MkX3N3PQkcq65lgieQDMhlQScdEv9m9a8SfFa56ieYfys0bMb4JBVsUP+uwbBh5at7/rLufnBbtz7xLPzhQw0tZ/dRI6tilRp/e4BpL3KcY3wfcbGnnTSGR3SIeLnN6zWusKx/hhEH6pWGUtrCMKBaZo/sleAHNk3Vwrh8854mbd8dDtjbAbsHCQs1MDwZvWDnx3vwDZ661Ybnp2z/cX//cO8hy45V3MuOX4c/9XDbMTrEgB4kciOCLHsGxQV+Pej2N0K3WCy6nF53weSen2t6r4eDkzfnJ3s453Z1j7AKJzorUXFZRw9EI9S6sMOe4UH3sLuPcxGroe8G+rjL7Kq1rpdo0FN//h7o5++Bfv4e6Mf7PZDvqFZ8tj3wPFCYWw9cN57zfYyuD9xlrL+LQt7nbi2vHFecI0WEcTc3E27EhU5vb/ExtGWNdBQ+XnNNHYLYaEVdiSpe0eHPwMHQ3sjdaRLzIWa1RvOR2bkZSC4Ke+fYkMWenZ4jQZn4HzBlROkjzRd4sgn/P4o+wb94r0bQSESPnt9EKc9nJWxlYIyTi32dexrk3VcTFP8BLavYYb4MtPzFcx+6VvsVXjhrqO5AY5D9b7GHXtk=
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 API key</h1>

<MethodEndpoint method={"post"} path={"/v2/config/admin/apikey"}></MethodEndpoint>



Creates an API key for the organisation. Use the key to call the OID4VCI and OpenID4VP endpoints from a server, in place of a bearer access token. Send the key as `Authorization: ApiKey <apiKey>`.

Give the key the scopes that it needs. The `config` scope opens the configuration endpoints of the digital wallet, such as credential definitions, presentation definitions, webhooks and keys. The service refuses any scope other than `config`, `audit`, `service` and `onboard` with HTTP 400.

The response holds the token in full, in the `apiKey` field. This is the only moment at which you can copy it from a create response, so keep it in a safe place.

To bind the key to a sandbox organisation instead of the main wallet, send the identifier of the sandbox organisation in the `sandboxOrgId` field of the body. This field is the only way to bind a key at creation; the `X-SandboxOrgId` header has no effect on this operation. The sandbox organisation must belong to your organisation and must be deployed.

## 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 API key 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"}>apiKey</strong><span className={"openapi-schema__name"}> object</span><span 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 API key to create.

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the API key. Use it to tell your keys apart.","example":"Production issuance key"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`config`, `audit`, `service`, `onboard`]"} schema={{"type":"array","description":"Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400. Use `config` for the OID4VCI and OpenID4VP configuration endpoints.","items":{"type":"string","enum":["config","audit","service","onboard"]},"example":["config","service"]}}></SchemaItem><SchemaItem collapsible={false} name={"expiryInDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Lifetime of the API key in days, counted from the moment of creation. The service uses 30 days when you leave this field out, or when you send `0` or a negative value.","default":30,"example":30}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the sandbox organisation to bind the API key to. Leave the field out, or send an empty string, to bind the key to the main wallet of the organisation. The sandbox organisation must belong to your organisation and must be deployed; if it does not, the service gives HTTP 400.","example":"6889e1a4c5b2f30001a3d710"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service created the API key. This operation returns 200, not 201. The `apiKey` field of the returned object holds the signed 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apiKey</strong><span className={"openapi-schema__name"}> object</span><span 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 API key that the service created.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the API key.","example":"6889e1a4c5b2f30001a3d720"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the API key. The service does not check this value for uniqueness.","example":"Production issuance key"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`config`, `audit`, `service`, `onboard`]"} schema={{"type":"array","description":"Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400.","items":{"type":"string","enum":["config","audit","service","onboard"]},"example":["config","service"]}}></SchemaItem><SchemaItem collapsible={false} name={"apiKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed JSON Web Token. Send it as `Authorization: ApiKey <apiKey>`. The token holds the scopes, the organisation, the organisation administrator and, when the key is bound to a sandbox organisation, the sandbox organisation.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0..."}}></SchemaItem><SchemaItem collapsible={false} name={"expiryInDays"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Lifetime of the API key in days, counted from the moment the service created or last updated the key. The service uses 30 days when you send `0` or a negative value.","default":30,"example":30}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the service last wrote the API key, in UTC. The service sets this value on create and on every update, including the delete operation.","example":"2026-08-09T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"expiryTimestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the API key expires, in UTC.","example":"2026-09-08T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`igrantio`, `aip10`]"} schema={{"type":"string","description":"Type of the API key. The list operation returns only keys of type `igrantio`; these are the keys that you create with this group of operations.","enum":["igrantio","aip10"],"example":"igrantio"}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the sandbox organisation that the API key is bound to. The field is absent when the key belongs to the main wallet of the organisation.","example":"6889e1a4c5b2f30001a3d710"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span><span 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 user who created the API key, and the moment of creation. The service keeps this as log metadata.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the user who created the API key. The value is an empty string for a key created with an API key.","example":"6889e1a4c5b2f30001a3d6e0"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of the user who created the API key.","example":"admin@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"at"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment of creation, in UTC.","example":"2026-08-09T10:15:30Z"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"apiKey\": {\n    \"id\": \"6889e1a4c5b2f30001a3d720\",\n    \"name\": \"Production issuance key\",\n    \"scopes\": [\n      \"config\",\n      \"service\"\n    ],\n    \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n    \"expiryInDays\": 30,\n    \"timestamp\": \"2026-08-09T10:15:30Z\",\n    \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n    \"type\": \"igrantio\",\n    \"sandboxOrgId\": \"6889e1a4c5b2f30001a3d710\",\n    \"createdBy\": {\n      \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n      \"email\": \"admin@example.com\",\n      \"at\": \"2026-08-09T10:15:30Z\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"apiKey\": {\n    \"id\": \"6889e1a4c5b2f30001a3d720\",\n    \"name\": \"Production issuance key\",\n    \"scopes\": [\n      \"config\",\n      \"service\"\n    ],\n    \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n    \"expiryInDays\": 30,\n    \"timestamp\": \"2026-08-09T10:15:30Z\",\n    \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n    \"type\": \"igrantio\",\n    \"createdBy\": {\n      \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n      \"email\": \"admin@example.com\",\n      \"at\": \"2026-08-09T10:15:30Z\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is invalid. The service returns this status when `apiKey` or `scopes` is missing, when `scopes` holds a value other than `config`, `audit`, `service` or `onboard`, when the sandbox organisation of `sandboxOrgId` does not exist, or when that sandbox organisation 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={"403"} value={"403"}><div>

The caller has no permission for this operation. Only an organisation administrator can manage API keys; an API key cannot create another API 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></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: eJztPYly20aWv9LFmapYtRR12Tm0U1srS85EGU+ssqXxbiUqsQk0ScQgwAVA0RyX/n3f0Q104+BtWYnppGwJ6OP163f364dPLV+lXhKMsyCOWqet80TJTKVCikhNhZcoX0VZIEPhq34QBdhK9ONEvBmr6PKCfvyXSoJ+IHuhEudF+8s0ncjIU+LZm8uL5/86v9wTR53DjnglvaGANslMxH2RDZXoFrNc5JOkXSGTRM7EMA79VMSRsoHx4qgfDCaJxKZtMQ2yoQiy1G4CkI1k1hZeKIMRrCfyRWBASlWWBdEg7YhrmB8fq0SMJ70wSIewdnWvADqGMYgIRr2G8gKh2z9VJn2ZSZphkkL3IBMypV6ZGo1DQCehCR8U8FEzmhmguBmHsfS5hUx8WHk2jZMPvC58Ohn7OEwYD2IRjORA8Wz81IsBXv04HitGCqy4nymcNUiLpyJR2SSJ0s5vUavdyh9f+rDzjFPe/4tgEGQyfC/DUGW01f55zSbBGIn6P1hC9jL2Z63TT/RrAC1bp1kyUe0qcdWQUxYjXmDWjng3GY/DmeiGsqfCLq9fZiJUMs3EifCGMpEeLCttEwKQKpqoh7cPEa+Q4pqIpwNrgAcZvEP4JcwfePTm4PcUgf7USr2hGkn8KZuNFSwj7v2uvAw6ZkEWqqZ1tZZb/UbMhOSbxWNA0L0Ckg8U8gpyDFGNIXPDaFN4o4AEvDjxue+yrLckMmEW2K2sjqeW5iMmzXGCxJkFKkW8EzlYG5BmCawLmo2C6LWKBtmwdXpSRvdPk5GM9oGwfMImjSG4SQ96M5i48b4ixmUsBWmD0HumOoOO+IagFVdxktGoF7E3GUFjcXb0zR4wcgpjAT0HNEB/VmJ6ezyNEEbUN6nwZTrsxdLszL0MYZ7RBOgeyVNC81pG4Na0uFR0r+SMoAE4EgvH3Xbx6hwFTP2rM8+LJ9jEfQuUaeivS2zXvRrGsEj3eYKUBdPeAwaMuEPhh3IYmUx9lCAMcfeaUdh6AGaso0hr74k0eesvQb7Cq6M5jOaQZzp/i3PxswnF045psu/A2kQUZ4CYMcg30QU5nUInxCqIxzQ7i7xhnOCvHwK/K2CyropgTk+9vznrIonIiCFheefzcCmDKUugEPvDSwAX9I/F2j+SKuTxWR12hYY6Fx5t0VOeRDawFpMoFHSsy7SgZ/YMGPNViehuxJs5WhtWlwKb4CrqN6NeNRfWg0QjJVVj4IRs7jTLCh7xytL7tI8GHakcgayUkwx2K/g3jfuW0XEN62emKNqlHsiu7kpybPuSq6TkHpABx4FW99GFnNnbF01GPZVU4PiFHuPoPrQXIBqCsCAP356OBkdTBphWTkKkmVicHDq76MnQm4RkXeIg1GUmyITpJ/EoH5kUXRaMFIGNxA6i4q26j1kvW3D3YlBosqpp3w9VRCymgLdUhFh0kJPkgwk9vAt4tw8GGmwhzl+0BUIZxv7i7eN2uDEsCWsn7gCdZDKbpHdA2cCbZDkiBi5fXf8oruMPsIJ31EC8hgYiHSsPDIO6znfHh8dH1gjvT86drvja7a+tYVQyAVpRIEymhLKqzIBW3d+n2d29d4f2UBennsIu3WUI4p0Nxr0NxDtsJID8+0FIBFpZUgnlNjZIXwBRtk5/bVnP4Wl52fioEZzW7YPpgROeJ7NxFg8SOR4G3j/UjJe4eD+5nTGi0mAQIRN+ULNT0fUD/xR+Ytn68cXhDw7s+i08wVcLwLlkmyEARlwIEjQ3Nga0F89If+zVgNgR/xtPgPMi1BtgNUQDlmhsXrCLMMMWZIA3myssQVg3FSL0JgpACkYqTVdnynSSGHluzTgBmaadlpIYR/mDswmQp2SZqqSZaTVXF5C+VUayrAopuEDxNNUz0kRaE8K/ubQCxLME9JEQIiWTfS3eLI+vGdyi0csg8mHrWITUmT1lS8eiIdxv0eMBxIhH2IpFbmiIdE3Xi1N1xzS/SHCM0vhu5MceMUXZZshJu8otv08/kFvGEwHfAI6atO9iZrlQQOVgLircxSl7QuTYmp0EQ8IeXPiTxKhZg518p/tADZ2SLXDnA6aCMNXi7+2P5+KHkx++FW8DIO4zZ+i3+YwRKYdeAHtkLAb9w11PgurQg73B/uK4cyjoHTMud9e+ttXfoa96EG3xVNsCJWoBBcss/H0xnmtB1b7APOPEmN3Uio1Yi7Kara4gdRHWAezqKIq8h6WQ8aTxlUdSQlKmBF8e/iAe9IMU3JXZYqP2ghuKwrSrCe9wHAdYTFPazaUbbJK+z3oyTgYyClKmDorv4NbaIR1CA8po1/rvYuMOUKr2yXrS+zBIwH/zL7EbvelULNAILNQlOEYvEVvXLc5dF2HP7r+ifWu9NBrMmms8ScYgCGiWYo3ncRgvoSd/Uh8BlyEaYbFfuxTap2Jc7eZ3//Ij/enu0byZ+phtMCP0FnFUO7OZ7pD+6OlwZxfT4esiGFjFGg5e3X2gicUruHn72gxYxBsJLhlm17CWxUOchSBxI6Dpe8WrN4h3BnxwdpSodvGqXxZb9XnX3itNRAA/OMr6rUrHcZSqS/DFEhA0iz2qf4I5NZqMxDgOQ1Qxge4pngFLpQrkop/u5djSPEYCYJKWVRIIe5WgxWFp7leRP45h0JJVsayla43Ut4zesjHWcV0CFMToc/zrXDz7+f31Hrz2vf9I/X1oRC/JpXl3sQ8voVHHsgvo7bs34uj7w6OT/RdidBF7B6OL1ywrNQx+ob+nQ1SpAFQXF4KBk3sv0wIQxqOHJCvJfWdJaWs8C2xcvIESw0kaJFJ45BfRUq8kxhYX4e3nd29+wZZoBIJCTvPAUKrCPIAylklWJ9/kTAf/XUNNw4C6fiCDKOWXHL6hQKPo/rVzDyhc1nPjEFL3r/N7WDuHLo1jwRks4rzw618JV5lrgxk7tcHaK6sKm+SwpeB2aYcsJTKoV1sf21TQNOeiGP5KNC2xEk4LM2o8BlvdmMJMVMYE6duhDpe+LZ+KTGI+JwFvKDvLYMcyIp2ugHlZcAKRLiai+sg/mjqWq7ckXopdXAorRg1NkuhUTTpqApJTdpQHP/nB6Rjs8iOtmjSTLWFCmKhuttYCcrpbCX4wpjpBGndInHRedI464Rgd405TYPlmBaWAodiPpNdCc6jIJ0OOYefH0wj5ObXY1YS3YGEwVp29i/yNtitKNhOhpWhtDcxd5n4SKYm6D9TUOt/Ds7Sh8j7Qa9/sQU8BohQJRhPSREAYK08gKFIG4umHQnSAwWL3qySO+6sGFyx5Lz1PjckxBJ/HliJjHFg8Q+feer5ng/HzNNva9CRUzazwPxjfqVZpz/ickqyPI3DzutToDmdM7zQoyrAbwGthJ32bHwwvPDSgxzpgOdObZy/dOL5I2imFgxhY1h8GDNHj07dKXKNqGlpjLwbvH/OAMdLpG6vFNxZ41blhbXdpFieu8Vsf7TmjPYKlIUJ0J7QawbTNZnyMo0VhG62qg8tX52hZPX8BxmwaeHtLRWFAft5RpzvqhF3yJyoaYhDE36++GoG3gwcxzsNhMBi2bu2zv/LoaFCDSEru0M3HbarE+BegAjsLt3MZJU9y2bhwtDy3RG8w1OPS2ZNE6ldLS+SXkt2wmKDO2SapeCJtPFGlQcAnAV+GHEnKMKjaK+t4EGTI1cSxGuyybn56nq40ve0S/KeOWNdZUcbmqjunraCynnDoeLuCMCtpgN41RuDraCnfMxegseuGNhwGVEGpOKEMUlAJRmkv1KTnhSRfEJ9Se2S0KrBNGECUDGiZUwBjoNcMv3LeUBD56mObdj+ahGGXMcKH63pktqepeUe8X84RQJD7QQKesAUfPsSoAcUq07H0VFt724AGTmDK82ayaWy66gQyBoraGpw4p075cSad7DuTM904WSj5ZtYaNIyydRDEp/ea/39tSd/HIAOdkEwwWYFs6BGsR4Ksnm1iBIZTPOgPIi+c+MqiGMfFwcAtEsYIfifKIJ7ElBMakUOYwSjILoLUC2M86FsHJj5xo3MnnwdSFgkzUQcgkxE/D20r8/BXZhcQmoApYnYZXlnshHM8lLtolr9tcBS/vFh1Im4ri1Jia5of7Igk0wciVod3E1pWtzYPqIhFWU5tT4XxVAehvkYh6qz/i8jN6zqBWLOnnS8kqCqQ4F4Vrv1Tk1pbFCLl5+VIPLXQ2YBLRQZT63BsnWxhN/2nzE2k5owvUTrqfqeKxMW7w6OulbBsAgEdccZbULHUaqUJzYbRNJmEGLK5d5fngpqffsYjTJjPthbFIYllLPZifa6tbT3fxco2TBt6f3O2AZPnyQ6WaZDFGAFNUQpJncv2Xh9Lw/TCCj+JZzD7Xl1ih32qbRM+qW1aiPKNbfjq5uLSzHCWeEMQo14G1o14i0dxCrv+mIChiHc3FuYm0aGhJBNGp4hwEoA5wtsAV0WOj9Y0eh6T5qKzDZSeqTZFw87EbVrJ8ikTPIDw61MnWKE0ZvAuSNq2M0zjcaCa8ipgpXE5a6LS0k684A51eRWFVIJ9uSf6Hwk1GmeolGMx4es88D4R8TQy13naefB9/es8y4u2Xd7HLu9jl/extbyPkkXHmfxNt1VuCzuYYMArNPulNAh8TurUuhjQugJ7AyjG6HRtA13g9cJnMMhey7IabePEVbIkohtv0vy61HT7AuZr1d0aOPr+sDYrny/8VdPlSxncc5OINeRz03fz1dUbY5bNNM9UarXmpd1Wk1E/vsBgLdhL5BI05qI25lRaupJl8TJ77RIpmmR4zUr24knGicieQlYjRbNoOL4vc184DD7f8XTuzOI5tRR0N0n5Wqu2yXWa4YQ9fQygQj4XgDb61ivZSASHZSQhM1ZEd+svffrTcsRrS0tC96C+mmD1oi6tyUnkoVyL1pxMhpYdKjc/IVOUQ1ZM0JaHyg84jFCE4YDZ1+/sxPA2GSYErguDbONxEjVAattwFBCzSmV3G6GoFyTZEC2i9bqrEXDeel37chSEszvi07UGGABXRhv0D9I7NALvjr7frP/x0Wb9v32xXv/xMI7Unc6BvH24fXiggIdWgzX5fjtluFOGO2W4HWWYZ7Ja2Xqtii7sgC7sbE0XNg8PFvRmsmyJodcVc0sMva4EbB6a1NrdBnqtceQNNF7zoBvrwuahN9WSzSOX9M9WxwaDhkKomxk3S4zvrW3NLTP4JlbnEuOjmtv6tlqjo3lZsSzsJO0nblGY6Va1KMo3E0wu/s7S2Fkaj25puLdp2NL4da7rfducXWFZH42ioe5A2RHDa/Us+eBrjuE64GsOYnvfaw5R53qvNFTJ716pr2WCrNSvYmWs1LtsSKzUuexrr9XZWKBrdTY25kqdG1zsVy/fv1k22PwKOVTJSLzEy4VALOZs8800UgmWd3rGw21bL640cVVDnuxc7tUV4TaCqq/VQIas8Fx9h+puW66kmyC0ev8QgfyFZUGVK5aNPe14Y8cbq8ZY6m8fbosvKqNXkum2M+Zc/lnoYe34Zsc3S3sMTc6s8STm65vP4EuU+WmlzlXG4bQBLFA4whIGDFAp5XbMqaUdwSRjp+eZtDwAohd/dPOUwCvEZKI8c8tUZ+S7FJgllCrKb4J3Q/Aj0Z/kkrDJfeApkUwinSeVXx0uLkBw4grPjla1XwtDm9NIA7xKYVUo0AlC1B3zpuugR+8VMwvtfiNZZBfpue0+HfHapFrpBQntjpukKmuAzm/Rb9G1vVzFN7JzbFgVhhBZ1qUvpasOg9cNXj9fjE0x9e2Diiz01vSIxNnVJWdP26jO5If8EkkNLvLSh7oz1+YbRDEnO+YQU2YZbJueZx+bgsdJSVmyYYOwGBiNjY0BVY1A8G2Aq5trcXB/fMDpdwfSHwXRgRwH0PvgE/xL4ubhQI+wDyPYt6h+i7r/sw/swFtw6XfN9RxfjROFePI5sczk8+XrspCF1BdEWJoBwOU7ySLIYCWw1zg8T/0mGeD4U5hcBP2C3HsxXvqhYdOCBuoWTPVB1EcQ323+GbP5MTU01ml7ZXLVjXAxYTxTfkecRWISfYgwwa9gWk7ud3i4fnMM8xAfmEH5UpI7ArVj6Bgpwg/6lG6alaAEWhgBrTEX4299kNO8tT9dX1+J54eHdFsC5Q4jCX7TUTEXtS072cnor3IV7KKiR5Ev/e333/+gjuRz70XvuH9yeHh4JE/8744OWw+3FL4lJUGW0PHhYfUCgp3KSUmOfnOWI6HKZLr6VE19+YJ217VV0QUA1aYNOT48WqkweOnmS4Naqi62fmXl9HyNi06uGptuuARLVCe9rCiYxrza/F4S36PL78HpLPC0/sIRcKZb7/mH/pF3LE+e77/ofevvP1ff9fe/lz8c7h/1jr0T/7l60f/2sKlAx+USK6pqTpliLjuX4m4moMkYE34Rt7ReLqqBBYkuOMprcrqbRwCKW3QZI627jVGk9a6HqZgq8r+xuH8ZPFV3XgOvtS5LIS7aghRodr0x9VpvGtLmmZ0d2lD8CvbpI9X1BeN5NHZLXqGtitwFIpiU8pxC7FOZ2hyRY+/ouxcczD7Ee+CUS/3YYIV4y3QU+4jkWuC+JeAesQz0igXsHWrcTp32LZVmf/xq4EUVfrxVV1x/k/oLCjaTRHH1qxKfv0Y63VHRB0K62gmj6Augay1d1ODzzC0Waq1sAB52kl9Lpb1iMV4YA5aGSn+97WCV/Wp5L7dCNzlSbIlVB7FovTwc1sfVNzhq+c+4aC7znNurW0+KN+4ebLJlIK1G+Von6AvwXCt8ouzyx3P3yb5q5V4obD2uAPxCdfC3UrneMgH1WKlduh7gsajbKjJWXfOfsYj9FivRt3bl5p/uvdGtlJvfqMz8livKm1LyWNli7Vryf4Sy8VapePdjE+ZamFUciCs5ftE68T89leLwKxSCf/Ry7isZaKnK0mp9kxUquj9OYfaK7fq5bstSjtASI788v3r+Hdg70WCCVx0zOcjHr16hduvK60IMiPiuivb//lJXUDURZRnNBIPBPG5ip67rRz1393t393u/mvu9u7ruj1LX3VJXf5pa7G6giIuy41Y3VF+nVxYi6blVZ/0z1lRfqJoXlx7bSgH1bddEX3Nd1iY8ZgH0NaEtmOsxqp3j1tWXO69wx0R/9LQ3CfSHZz2rFl5tPGJXSWlXdXxXdXxXdXxXKXpXdXxXdfyPSkuft+r45kZd5QNGX1eB2idW5ftHZzuWLuft4O/PV1j7yxTLnlvT9hFLYG/FIV26tvXXJwLcGtWr1Iv+WkpEL8EOD3+cYs1OoWbY3EqdZid3qfA7/TyFvbYoM4yE2ekoXVDQQDv+/JpOualyce7fZnmCJaXYceY/Uof2hVMs6ewcPexKLv/ZSy5X84H+cCWRCehZCjLynzICP8VfB7RxKDMMx4sRjTE31baGOABCHyRshumBDIseyJ9HGB8zFaWEUxREK8OtP4JIQ3C5d1Nw2Z4Tq18sgcFNTnbrjYy10t2YgFNzkagIbgOx+4mcLncOtZ0z43RI90nsk2PO8mSVsNLCHLFKd+nmVCvZHU8/seNpe7368WMfWTsgFIViVj7GZqKun7beeqhWb8+v6rmfvJHi5u1lHYmZKz00GkGoT+CofjuIJSrXbrL6m3J28+xuKhv/pM/dS2IMfWnTkq8wBr0A69NUP3SCqyiAuf2cp/eLN9uufv+F97yaKfA5cg+qe1H5fAypllw8u+NXpZMtIzSzVnf09tESoS0hcnL4RbOiG+2Qp5Ed3V45H7q9Tgb0NpOdP2OGrqYoK1HXvne3y9L9olm6tXejcrGqQwyFHHWg3kKK7zYSoJzbovaHfjTK+PN8fKarvzJ/WkqPeqZzWjClpe1mk7iZUfjWyt6oS4za22VGfcHMqJpvPRnOKV052ULyk2244EfNqlFvi4n0t9I43OaVqXjLiVSsz5Y7XOuISw6mFrfkAJCujju7yy/lCTp+xbxqkdtIt1q8poLAcr+4GtLQa6xjXSNRFmZlOR5sQ5HbB67IQCdfixf9i2lqLxi5qBZOWzG5rMl2sT7dK6XbNNw8tb/r5x7YmWM896QB9WVxVIJnF08uTY1ZjsHanWo/1SOt3an27lR7d6q9O9XenWpveKrtxpi4UGV9BZ6GgjN28Re74ko7/zqeOeCpiTXVeHHN1kDF1ynO48ElwLLpZ5E3pHjXB1qIdf5ZF3GqCfnMD2bMjywsf4BpW3flE8Sawznydl3Woo3TJc6AdPC351xKa+liVfa2qySJk/PYR3Do5wuL8m4X1ZsqehdErLWqbe0+p6o3leHr/P/cQH4p0bEYTzKR1080F7WqZbRMfCZAZiBSKX3628SFA6yXQkE0FsREqCR9zWfBgc3TIbr9JH0icYLHrbingO+224t9M4HH4ck92Jb5eS7Z1e2KrHfDP10dILHCL1xdpuLlCfb+CBzb1KDxZUN1kq4u9JIo8FHxtE0zDPTrWhyDv2JGAkm6gmuK0d3r8azEgjRPAqCKe1pBZPGY81VN7RQ8LEYg2oVbi7+je6Uj+nKQKIUnQ3MuBSNkdCm4AMpQsOtsVxFX7CuJ8iLwzyqd6uMVkoW/m1vmraOvmLduIrMtJJ9c1Lz4qsUOiXp0Oon5wTbAaUo4woC0TuSm0q9nVEITfqTisi+pvijqCXqCq5YDqtN7oT8RojNrigswWLuY47eIpJEpRjyOKX7PVlbLquCpvzWyz8kEB6jFA/8g9cHSPCi4Zb/w61Ep0XrqatVeqFGsl4v6PsGyy8MsG6enBwc+vNuX46ATDBIZZZ0gbuEa3QHADPEnnk5wrx1m0QjvAEUopRu6p/y6DMhtsQ/vkByZisxuFGYpP2iokOmUaqie0JrirU4evx1m0UKq64zTNeVoTXlRkKv94KPJx+syjKIrnoG0ZN8nS0BqEQ7QithrCw47OcOeCt3xb1jMFNGB5WL/i0OoNt19anGV27xA88/vr6trsyrgAlukqQGPR9Iwo8B3y1nkGCQZQAYudWjl/I37RqYqSgst9F/G/uyV4ceivvecYnTLlAe3WL186LlR5e/F5X6ss4zlivHYpyFzjtcYwLkHXtxkmYrg69X/1oVErBBd5WtLDdG7/HH1O0X5K/szRflDk3tCJ+/F4zyTwor81yQxOL0W3fk/3EIFcz3VrfmCRoGO/KsB+aPGUKjdZLP68PlAjRdJHaoqLnjy4zmXK0uXGZ17X9WrSbcNV6ZqWhYX1rY4phPhtYrFz/k6c81XFGq/tvBwOyfQVDPVolBBZV6qLd/47YStUYidQewQxeIkXW7+B5MFD6j2+7GxaCUfqvH3rE7N2v+7MCpyuyD4e/HItUZsQ6a05rwTZmXcBz45kl6MSg/UfID/onbLM1qWuUlQW2kYPbH6jlfswelcbWNiXu0hRFnsxXxIpDP/FQUkUp2q9W9dsjWL2cPmZAk+x6Uv3c1qvnKX6lInICWAnhM/3af1BhKzrcN4qgOcGtMErX1s2i6dIvJsC865zMk9hv7AM1Eg3y16PAMDCvB63DmsbN10Ou1Iet2BJR/ovunB68vzV7+8e7WPfTA0E2ShQwOELF/bJsZSLFj1+PD4eeeEj/nQaAfWtuA558z+2gO3MtdYfpfuhxQUqWlDUhuic52rKHRr5FVRN9ZYsQ0xBw6ecmAjnlPYts2bjYffld1qG/ecoggGpFRlWaWIiVXalkOzBOPSuS/mK4p4CQWD+WReqxHGceqSdqkZzQxQ3Ix1PoTi7FmZZNM4+cDrwqe6FmyRocmz6QqxVpZjUQxc3/LIaovTc3RCGw0oDw8ATvBUHjTtFirl/pgUF6KbbDLbB9SxXAqSkh/oGB62Jwg6Zoh+JQz46ROWY7tJwocHfAymYUJeLNo/CVER+7TGZyLXEdQCXzDQ3w9oJN/dJ1B2n0DZfQJl9wmUR/wESq0UReu45kMo+hNnLYpGcZtzll375B4XLSrhz6IHF3uY29YO6F29eYdhmF7sk/08olBnK5FTPLmCv09bv8F/JMt1qOMTP8eAB9/KQVeVxjU1Ud1AF7sC+geU1+ZVNLOgLMe8eDH4Ny6ttsvfkIeBS/4rb85vGjvkUSJujXuBn876f8k3wxc=
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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={"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={"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        \"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, or when the claims fail validation.


</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-global-configuration

---
id: config-create-digital-wallet-open-id-global-configuration
title: "Create global configuration"
description: "Creates the global configuration of the OID4VCI issuer. The configuration gives the default branding, the default validity, and the Credential Issuer Metadata settings that all credential definitions of the organisation use."
sidebar_label: "Create global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztHGtz2zbyr2B0H5rM6GnLcezrdM6vpuqljSd2mptpPRFEQhJqiuARlGXV499z/+N+2e0uQBIgKT/StJe2TmYSmwQWu4t970o3rVDoIJVJJlXc2m8dpYJnQrNsLtgsUhMesUDFUzlbphyXMDWld29Gx8MfjkZMar0UaZedwzN/4UxeWTihmPJllLFJyuNQxrO29/SKRzKU2brN4C29ARxCEWcSzh4RePadyHjIM860yDKAgHB5xngE2JWLAaKMJR6uczRVOuOx1AajpRbdn+Kf4oPYfx7wmM1VFDIVC0tQI+1ddgAIwKMQTwU2sVT8eyl0xqZcRpqtZDZn35yfn7Jhv99l77QgHJZJiGtVIixnMsWCOY9n5rV/RKvdKhaOQrgQ89pcy7GcyYxH74Fukb1JBKx4RXgeuTAAhMXrUIXr1v4N/SqBT639LF2KduXKj+1FIOU8DkTJ5KlKCcX8kg+A31MpolAzniJFCIFHbTZZZrRQi/RKBsiXJOKBvf7pMqowss20YtyAMje5VksWCX4FQAHUTMHWCQ8ukVUy066sLAXyCMBlcOtIHE+SSAYEt/ezRopuWjqYiwXHn7J1IoBGNflZBFnr8aRX5fyEB/NmmSMxUlciTWUo2Lhcc3KdSHuh8TFf6zEJurPgUJJagJDPVajHRkY/EatBpplAnK1IoAx/LN/ZW8HDuswCvBR0AInSAv7hJerFGSseZwj0UoiE6Dt3SODRCtiCvNceW6y56EZqprrLVNYZl69AnGepWsbhaMFnwiwGAkQ0NWZFwh3PYpUSnxQq5krlSMqYaMp1eQJKUyovns0kAiU4AV6w/b3QU+1r9AIFNEnxdSaFRincLAyOjMbLxUSkG2VUFDsZQJYqZM8A8xBgPCdp9Y2hNhIbMuCJQFGWumrMRsC7Kxku+UYj6kk0gbCC4N4eWFXNtvtsNRcx3TUafjbuj8HIWtmirUbqQMyQPeKaL5IIqN7u37Zb9Rt9uOqGUoMCrFnJ8Nz2O0QFPA3xnldkOdm7ka7fUcwXwjlWZynicd+xuIvY77HePQkEEGQ7EYEEDoS5tOV2ZbOv89jUOoH/1VoIdsjDmWgB0yIV8OgBGB8enQ53WQTSuUSpzfisMG4NvHsmurMuG4u48+pw/NzHgR7i0d4BD+XYfLngcQf8WMgnEbr/YlGNfxYvUbszOLtU9SMVqfQR54tr0IAIj1KhKHhQlZISfs6Lv31Nf6rcsI8Rp0xcZ58AG4CC5roJqxyVPv2poWIet25vPWV6ayzaSRykazr/bREHFGhOlAIdjWt4vkdtHmO4MDbhmr2GxRJMpDAQjSBjGHJMBPwAZmkq6XaPnNsc5c71mRX6567UWyTBjAC7nGjjC50fgxJyKdYeyYgY0MqXYM1T+QvPqUNy0U6uHRIlhAqzBsN6Lheik6lOhPYKbamJ7aw5dZX0wD0mxxg86TTLTauxyO3q3anpFFaQ5Ra6Yvcqhs+LARzseZry9UYxIgapWcqTuQyQS2xiALGFgWRccMlWliwnkdRzoR9hidj73LY32XOUWXAUJsxte8EJ+YZxKMN9QA0Eafzz6hL/u5ShdebXO8EYGSMzsdBN6iPALbb2f2xZIPAEYFAEqMUHfHBx67C1uu6iohA6Ab8mRiARKbiy+53vd+ALF8sFS1QUIVel3dksL1ZHyBOW8pwzGO4MXCkYNYfTJ3GYKADqycYOIB2rDHTJhLX5opMYdSu83zdCOpClKtLe8d87EItzUXBz52Rfgb/XFB+cASk8/xVDHGMO8CcrRARf5KCQC4YDVuqWFEPBDznIms8NUz7NPgy2P8Yg1eQZHzYT2YhZzhfCgQ22ybtYhHY+A4R2XIR2PwOEdrvGwRiwuXG4XxrPIPJGXdiYW90dA/kSowGYCPP3dY34dcy5o/IAQRxn5nT27ftzT2Gn4OYEWRrHGv9TrEcEDAxlY2AQQ7KG6Ddn5bCdyWJ/HtOihaf7QUzuwxlVGG0sHjQ2VmncyD/IlcBMExVjkroqIV+rdMGzxxNh9uXIaysIQESbhMAy0PgD6x0wawCv0N8bfxz6Xm4SYkILphSyM4FZbZnCGFHmAWTO+lxdivi1nIoMIoJRfGbM+gMiiG/UChJEoAjcnwEFxhFgGYKlzoXMnCpDg5z1EjPUNc5isaK6ExWPMOdOxRSChbmB1BAzeDHPEQSPJuB5DN5nRs3BOt8bAnmnmVj12duvj9iL3eEe++9/ht1Bd+t5QyhkywSw3EY/Jn0GRsWKeAbLJ/jS5M2hSWE3Eg1mKnm4sp+XiNsSHwoEerplkqgUiD8+VaeGkL3hcO/5PqG7yHUdLAIWP+DMD1ZmP/Bo9oEkR3+wQADnvGDp3T2wYELpA/jJXGWtApib/8IeD4ZNTbvszXTKJuu81GJjLQgcjZkyMAsfSwKl2aHgKfIbX2qQqmVKiiVR1aYMFAGOhmeafrVRPx3aaLaQ0EekBt/xS2suSzIcXjJI84CLKl0zG3leDbr9CiH79ndbdDG1U4wluYWHRa9UoD8RoDbfCwGhrBEAOvXvRF9Oc+yRHLsLQTSxPojyl7kC7clFm8nFQoQS4tdo3ciiWEEC85sqWvCBzsjLNlZ4rK2wuBPPemZdzslNumdXOcpXzeLyghdnxuCgFZoIwEcgU1FV4SqujAAnSkMonwdxnnK64ffdla7t/qZSj6m9VIscVW4Wryf4GpXqxDqQN045v9VQIyiSdS9XL/PmB2bNxsXdlXQCQ+7K6mrpyd3ZyU5TsLUhAiJJvTsEQUe62bfj21v6AzEXT+FGAA3E+aZyDW9sLbrL3sUSqG8IUzRc7URd+20WEGmMKo3AS11WpIvsksrH9G4ueIh66VW6lzbiKTspNoWlbsB1EWegNIWNOLRN8CSxKDfjMtaZqxW0HWOrJuxRgzCScPcteFmfamg4ddlrmy4LSxCly5YPFQC1qjhWyrTLDVDQaF2WWVEMke8BNpcoeuCgvuQXXH/ksLdhR8wOTkcmIHNZnRUmvpEX01Qt6K3dbErsRX29wBg8k8Jrs+d0cGmAdWqgmm+4IKxflKGu2owEETA+fXfOeldbPVPb7vFwIeMeTyTs7t3A/6QCtz0LoQMQIFqE+wP8iOPjf3XOlhNzBSMTSZrmZJIK5FNoKrx5QFfQ5TALpU/G6JYBXWR9AhKWmU4NgjdHg4lC+Cs4nMlpKe4TBWQYsLqUgSaCTentGmKTtvl5Iij4hFMBWloXV7sIiUG7CX70IGbL+DJWq9hRWuyQVHS4+XJy5SE9yIGa/ooPgdYZ7AxTWCixEgYLKliCLCxA1owWU+OIy6jSSMXqENodwyTMOYy38Flru57GUFtjWGsD2rTFdVmtFy9f7okBHwY7k60p2O/+gG+HuwPwChcI0thkcvZb/QEVLWqxpg3zTVM43Ng7f1Tj0k97Zw1t3kZUGnv21RqgRRTxqabu/rEybMr5/FPfQiSD3ZWaE2huobuas7BmJs/KjHGTaIHz2YGUoHfZqBA8YxBAJ80WyMvHDdwBXTNNvA0vc9eRcBA1izBa3HberkepDgVYBbfR55fdX7zYmW5NXgZ7fBAOBQjOFp9sD4MQ5avx1PuZudGj3jmW8Epeuf25T0HbZDccTId8q/My2BadId8bdPamO1udfrgdvBC7fDAZ7iCdiqYQ3PjrIWSOavTZNoJ1psa4LNBekOzidIZuamL6odufvLnqdqnNdI3bZbUTAJ9Xl5U19PlTYRI1otmc+0foxv5eLVePZWohM+32W3ILaTQiVkU566kr+9l2ZVFwZup+ZXuNsyZk7/JSvJ6r1YbDfTkxszPFjEwZiwvfJXhDLjWlg/0PcFFvX+e6n48H0ZBMKR5YKPSR1XeZBS1yEUfQNuT3wkSEX8zxmIKhoc3Z4Ec8hBGnwgi1JiPFi5qKM9JTeD8SYh5l53Db97PgAGgmucjFtQTZRpNtq5mUhcmJjGS2xoKzG6H+SMwuz7zwlIimmO4XmMNSKww9f0ThmVSJ8O2OkZ9m9l1UH5LX8M+s2ybXMljVrPO+2jj+c01S/LVGJ+7uUf3OoxTnpVZpr7dVN2KFj/cReRqX+MTjEmdgKE1XegVXPy8waJyL0I9srT8knrvj6ouJ56fBiafBicpnL+4zM59a6D6f2YvPcdbifo5bCoo2s6T+7Oc0cPHg2Qk/7GoWjIunAYunAYunAYunAYunAYtfNWBBITn2aw6y+yPwd7G8JmboDED4nLBuv1qsBpy12xIqDh/sDnf7g8ELwsG0Dn5THCIOzFqokEqzmzCpuB6Jjb/mZsuG5sSdDYPGKvnDKgF3ptR35Kt3Zlzu3bt3UKt8NDUIL6rtPYpCba8ZrhF/G/b7NLbz0LakeyakZypFB4lXhT8fO2JQO7waTZa7m9S8uPohSV8NfFPqW1ReDznWqBOwdsUgS8tOttT9mFdpBLm0DXKvVlPreddKlDzCGvraxtC8sVHXxnH6vKC2+fOf+WkU0bSZ9xlctBr4TudzJbUGc/V6B3/h630X5ypJ+umzZucvLflkYWKQUBu40TEVHsEmsNvLVGZrGgM7oHEa+BEi+5uWCZGwvkdPkGo+oxk3+zF1Zj6nzp6ZwiakrM/hAJM3IZNMNQtwAd9HTOIIquVM84QGUMdoYQ/NuQx7RrU6QeUz74aQpoG1Y7FQlk40ommEwyRZluj9Xi+Edx2eyK6E5AucvVQtJM4HcJqqcBk48UwNzH0QzoA3JpVv3K7N6yoiF+UFnKEcGvHJr6Gsc5oHG8ZkvApsvZWRT3CVs2HFmIaxVTa0HntwxvlMWj5jlEBWJa8hrjJjWQZHNmbPwFoZS5WlXFJRUCc8EM/bzDTPPLD7zG78EieakB04M/aV+VCCK3A3LTPqlufJrW/fn9dpc7OGhGudo2eje4MzGmO/Sl1wkJSfInXaUI7L4L1RFoxm4m35ZQsnT4Owf5ZBWNSmqco9BA/IQ4ArkKi3NkP9R6mrhbrJV+UjX8ld+1C50GITZQQyxIQCXDteKWiPxP9xGMb/BpaPaRdhmtK88RRSlOKIwmSfPkeMMhWoiLq2EJqgxRDEbG1DoF/Kb0GgW2pTFGQatld4AiTf1iW48wSm5A+mD7LZNNQdolfiF0VMIyzIk6paThO277eP2A9H7BnoOpiP0cn51+zsuAO/wVNz2ujsDRu87A+2OztscayC3uL4tdtUmtIVUzsJPD2k9sJRugOwS8DXrW6/dnWr1arL6XUXSO7Zvbr3enR08v3ZSQf34MSBzCJPBohZoQqWxe0BaNtIgHVb/a1hd7s7wL3oBCGxd/Ax3/nSGElWLYITxjx9g8///xt8rJdAC9tLIg5u+dZK1I2Ncn5sXW2ZaVDYibfpRTo2dXVy20q0A+ZyjkETwLm5mXAt3qVgsvAxUJNSiAZyxlNpKsUYsOVxAYVHwDfPWG4UpqdZ/6dZ/6dZ/6dZ/99x1r/ReGKk2DDxTxkKvKCMy6w5Mrarc45gyhW13L7ccUDXeOdaN1s9fXOGqcbEfrfagvL4VspX+AkE+He/9RP8JRNOjoxqB/j8ppVPhMIaA/fWtpv8ZM6ExfYHtNf5q3jtYFnN6wwx+C+S1rjlS9Rh0JKviuXmzcYNRSZkVuNdXADS/wO/TW/7
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 global configuration</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/global-configuration"}></MethodEndpoint>



Creates the global configuration of the OID4VCI issuer. The configuration gives the default branding, the default validity, and the Credential Issuer Metadata settings that all credential definitions of the organisation use.

An organisation can hold one issuer global configuration. A second create request fails with HTTP 400. Use the update operation to change the configuration.

## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

Default issuance settings for the issuer. All fields are optional, but the service replaces the full configuration, so a field that you leave out goes back to its default 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. When you leave this field out on an update, the service uses `did:key`, `jwk`, `kid` and `x5c`.","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk"]}}></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={"201"} value={"201"}><div>

The issuer created 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 that the issuer created.

</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 is not the same value as `globalConfigurationId`. Use `globalConfigurationId` in the path of the read, update and delete operations.","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. Give this value in the path of the read, update and delete operations.","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","nullable":true,"description":"Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The value is `null` when the configuration holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk"]}}></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    ],\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 wallet is not deployed, the organisation already holds a global configuration, a value in `credentialBindingMethods` is not valid, 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={"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 holder global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-holder-global-configuration

---
id: config-create-digital-wallet-open-id-holder-global-configuration
title: "Create holder global configuration"
description: "Creates a global configuration for the holder wallet. The configuration sets credential encryption support, the credential status refresh interval, and the redirect URL for OID4VCI and OpenID4VP flows."
sidebar_label: "Create holder global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWntv2zgS/yqE/moAv+OkDywWlzpt13fFJUjS9g5tANMSbXMjizqSiuMN/N1vZki9LNvJ3t0edrFFgVaWyOE8f/NgH4NImFDL1EqVBG+CkRbcCsM4m8dqymMWqmQm55nmuIDNlGZ2IdhCxZHQbMXjWNgOu4FX9YVGWMNCLSKRWAlkRBLqdeo+ZWmqtG0RocoSY7nNDNNipoVZMJlYoe953GI8iWgtLJVahJZ9uvpInFyMz4efR2NacJGKBH9eslmsVqbzLfmWIFsGiMhQMDlPFNBlk5zKJx1P4BCQNCSZgfy/MmEsUTOWFvOEiWVq1/Bby2TeYZ+MIFayNMItKhVeXqtQ5AabnaAVFIvGESjYqcmp+VzOpeXxF9IiCRD9RIr9QLofVTUKhDyDb1W0Dt48bhnuWlgLLBpggdumjRhP01iCSMAovDioOn8UCAEMW52JFnJtwUx4LBEKiafuzwbPfgxMuBBLjk92nQrgRk1/Bg3UCH0NvOFHhcnfFU4R3LaCVKOmLDBJJA8sLs+ZKhULjsqpa+PLQiRsgrxPnJ/lWghDkYJnencUUaGI8iB2JUyqEiNMh/1TZWyZgVPM5T1aXho2kyKOUEfigS/TWDgVbVBUctyS0DU59Nj7cYVrdO250A2u86XolkaAziPDpsKuBAhjV6oaLFrcq9CHmosbMEF4Z5yLTnoT8kirUpKeZ1YtYXWYr6qyf3za6xH7RVxUWHWO3+D0qhqKhcd5JRuBjIMM+O7iLLMLNuj0GD4oLX9xXF/5aIsyPKAwQ0VEaUzGk1A4eNmO49IWu4L46UiVtqaEYGFtat50ux7S/IdOqJbdEF5NeXgXbAp/vszMQkQ1ibxA5r/wzswQ8jrie/T14vLs6qjA4Vxt9bUjFQmK5brqiPxkxmMjJmyFPKzBvYHDmmszlZFqIjHjWQwhTxs2m01FW0+Ep8OMJ+MBHe95Gs1ZAB5SrvlSAAl4/XUbBC/ogcdg/kTCZibpaJBLMzUjjRlAvKl6YErPeSJN4ROgHK9VaUov+pJrCX3afVsIDrDq7JZrVmeJoRelm3n3J+B8sPnpCfAe7eSh5cJIGsh3cy4TUwsp2g6fd3KPGJ4oW9u3hMfaZlHb02EfvdmFFwjNnuthi0Ajl0KoRaaqDaaSeF26FMDNAvUeYuStJMQ/BxzjGhYiABvMQnciqah3x46EnV2O2Z1Y11Vt+Z0w+y0502pJX/1mUk4NMxzHEBkKzebPaeNSjHMHJrsNNJW+EMHFoKq9TJAAk8tPN6x7P+i6jN/l0VImXZ5K2N19hH//JtbjaNP1FNpAAesRY4E/0vjkH+3rbOpMMI7gmxM7EikgL8fchd7krFuVq6Is9D6ZZD7tU+4D4ANJwNZI3h19oedIfwWHMzkr3X2qQAxHtlJP7RKYUqR4kAZo0/NUxApQHU4Farrprn4RChOrtYg67CxhWXKXqFVSCVqs/bZieLdx8uChOMiJusqxToHWOe6cUlgkZzOhYcEWl+ALS/A1F8X4a8Zl7Ez7083NJRv2egiTEnHHKQl+oUXgd121tTKIoKzVrJh8oq2ibHD66tVr0efD8GQ6mB33er0+P45e9nvB5hZJ+ioFiQx6/WZJeFPih8uOUbUu3FXfo0D/calXr98WewtZJBzHFzPC720idQk+7OpBPJxttSBjS288NNSKYXEv9PpAxbsLIClZdhpSyeg5tVGodLQj9RxSfC1slx7jwJ8hUUIaI2SVCP/3Hvw0HUJie693aASA4LZwSPV7bQDhXq9+Tk9PZoPpq/A170dDAY424NPjYRihPx6g8rQy9ubhg8r4UFTbThifTFMOwef3Yw5q5dUd2jQS4AeVDFwvcoPpy6g/G/JB+1V4LNpD/rrffj07GbR70XF4Kl7y/nR4gtIqasMuKq7wHDHHDfki19vlAegwaYkwQz6Z+yqIuBWBwMPvovf53XY4f7zexfcmZXHI4xVfY5lpM500xgyQnyHB54VYDgo0UanEBJVcdqFVNl/s7HT+uP1Ni129H7HX/cHpr+x0GqAQQ0lSgQRI5InXOhF1mqSacSrgJKfxmMMmR6TDrsXuPrKmXdefQO50afbMVpSUZMvpjkgAYHxgVi5BZiDCXpQBceTgvokNoEaTZ/La8f2Xw5e9ft/FgmP0N+WBFLRUEQLeXk429eGPxDLoUCrZA72H0fBpTKqDw7McvGrHqj5vseyqa/Cn/VmsCS2QvCFjbw0gTQ4GWyAAhbcWkA221Li/rLql9tiX62B7/AU1KnrBs0u66klCa6UxvtC++HxekRwUcbj8K3fvSgqFvwzJZRvkd2B4iWRvOY58UmhhillAsHHDgWb9mw91pypas0gJVyvRNG9ywLEAtzzueONttRYFLNWa6qCp//6fWP+fEu7jS0QN1Zz8qV2T4CnBSw9AKQAQOmZLR1gIihBKDLumVumMRgbweLtpPQZvaZ6CAEZvUGo+x5lY4G8VmLtWYC/yZmd0BAc4wEIlAXcLhTcSqTKkJI6kgsrEwpewbRcCXYRnGXUdAnUd5LXDrTsKJ8+u2dy5WCovLqIqVmpFURLBtzZPZUfONU9sR6oAZawTuNQqykJ/u7STzFMUIDXMEVr3bDfu8zYjt6UdrtEdnRfl1ijcwU109k0EapmmkYiLYVU5BiuaQl/tua5iUqMzycdv+TglhWwoHwCe3ATK8cgm7AVglytjrOYyJh2kPBRHLSY6884W2TfMb/wBhzeoDhyP/Tih3qTqd4+Bm+q9V3rJIYaDv365acpWmfhBWBiTs+coeZ6x5K6XdoUGCQOo3KQNQRHfaDdKkIgWV+Xl2LvfZkxdaTGeVU3/mtE2es1M5YDIQwJEQD6Jh3kh/lL6ZOFW8kP5qu7M1TjYskixCXSv7qE1x6IcWE+pgZb4LzaqtWmLAxFKe5+FhsKPT2NRaRwNG/uWBwDHlepHlVHL9sZLUHlxRIFQl0fIkVWhig06PyRdjAyR4B7jc+0vvpS3iros0aJe2s367vGEddF7hxX2MkNeb2EZ15Fpk7wS9OAuPZ1Lek0Tt1+OR+zziL0An4YwGb+7ec+uz9vwC96608bXF6z/qtc/bp+w5bkKu8vzj9UmcEZhQQ0rJDYBXTVaNQcEiD/QKzSXDdOtVqsOp88dELnr95rux/Ho3d+v37VxDxjVShvXfICUFakwK6wHpBGNndkHvcGwc9zp417E/CVPKvy4G+lDY5ntyK4k7+//beB//98GPMjh7VE3jTlklY13lEefq78G9wM3sAUNonVq+do3VJW+Cx52Zu1bXAA1ABB8fJxyI0DGzQZfg2SaKg7wI64pdF39kec3SvNQ/sKHcra910u+X899v577fj33/Xru/3g9txNF77Bwb17SUaUNH6hzcGtGDrvaN0imXNFoVcsdZ2TGg2urzdflxTWWzFP/f7qW1JYGmq+wfIS/3wTf4A9hOZU91Arj+8cg5sk843Nc7+hiKcx9YV42JXfUlPiHypUbT9YVLrf7EycM/o2i7dzyA8YwRMmPxXL3Ze+GoqJ3q9EWOLT6N974Z/4=
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 holder global configuration</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/holder/global-configuration"}></MethodEndpoint>



Creates a global configuration for the holder wallet. The configuration sets credential encryption support, the credential status refresh interval, and the redirect URL for OID4VCI and OpenID4VP flows.

The service ignores `redirectUrl` in a create request and stores an empty string. Use the update operation to set the redirect URL.

## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

Settings that the holder wallet applies to all OID4VCI and OpenID4VP flows.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the wallet accepts encrypted OID4VCI Credential Responses. You must give this field.","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. The service ignores this field in a create request. Use the update operation to set it.","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. The service uses `false` when you leave this field out.","default":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The wallet created 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"}>holderGlobalConfiguration</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 is not 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. Give this value in the path of the read, update and delete operations.","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.","example":3600}}></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. The create operation always returns an empty string, because the service sets this value only through the update operation.","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  \"holderGlobalConfiguration\": {\n    \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n    \"holderGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n    \"openIdOrganisationId\": \"string\",\n    \"supportCredentialEncryption\": true,\n    \"refreshCredentialStatusInterval\": 3600,\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 request body does not give `supportCredentialEncryption`, 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>
      

---

# 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: eJztWm1v4zYS/iuEPm0AvyfZZIOiuKyTvfNdrgk2zqbAbnCmJdpmI5E6UorjGv7vNzOkZEl20lv0WvTQRYGNbZHDeX3mGarrIBI2NDLNpFbBWTA0gmfCMs4yk9uM8TxbaCOzFZtpw7KFYNrMuZKW44YOO99Zl2qpMssyXcqIpc06bAx7rTBPMhQst3AECtsuoB1PPJYRnM+ktbkwoIaK2JMwcibxm1TsenRx9Gk4ogfXqVD49YbNYr20naAV6FQY0mwUgTGhVjM5dyZdyLnMeHzP41hktDMa4+HnheKw24h/58Jm73W0Cs7WDc+Ma+qSfVGEf3ac4iVJI0AJ2CJaqEkmVIZSeZrGMqSV3Z8sil4HNlyIhOOnbJUKOExPfxJhVhP02T1rBeCkXAQPrSA1aG4mhd3uLCXYzEg1h+VC5Qnuvhzfjv41vsKNDcNgA9OzRjzqAeNhKFKI0cRLmTCt4lWn8l1isBh+ZeRXEbEr9BPE7Md/XmH2JLwhNFxwNfeJQEahN/MUbGIhtwL9KJ55ksZoT6H+pnDAHlMTqa6EmmeL4KwP3/hz8W3QOzptmn2lXRD2mf7B5/rWPDyqxebySaCZfxuPbyDm9PeW3X28gtU8Y0ZkuVGVzAYnULJEOswTiH/dpEWWpfas2zV82YHkXORTqAvjU6UT6qR7eT9sw3erIcp50hXLsE1y2yi1a8TMdheCR7abcKlo9fiq85zE6CXFk/1Oqrjl+LjplR9gV90jZWXXg2cXUHKwDOKOJ2GccU/E7WKquYlwNTyDwo0jTA5NJ/C4RaWbVSVl2gjKHpGkACBOU7ZcCMVWOmex4OB1mTGdNxx4eedyjTIt2Gw2lYel4UXilHnzW/q9cPuuaqBbyg08zADJoB6b8HLt/dNhd0oCDDEZgTYEfEU8LHhuqp9rYEMlY4VHZ/Czx7AOuy/8ZwU5HJ6hzsK0at43uU/YEjqLUJJDnrPidDQs2qtDy2W/tBDbOTgE0RE2LAlq3XZ4vFd7zAWls9o+9Gltc7PnXFFC4O/OIEyMwg8NAZ0v6ouqpq3BsFW9QUC2TTbMdvR7iF1oCckBXWwquIGFiIEW29SjUBX37tmh2PnNiD2KVd3VGX/0aLfXFzOjE3rqN5Nz5FxRdVQ0hsrSGDZ/ThuXhmAtxo2/EKCp9EWHi33P2qsEGTC5uRuz7tOg6xpol0eArF2eStjdXcPff4jVKNp0vYQ2SIAGAPED/cjjkx/bt/nUhWAUUXMgcBCpEeinyGEGRbdqV7U5QPZJlQvHJKj9AAaAJRBrFO+OvjZzlL+Ew5mcbdN9qsEMJ9Zuc2CfwQkWqXiGKm25z1MRa4AfOBWkmd109YvQmFivBADduWK5elR6qSpFizjXqOH9wSmKh+qgEOpQsi6B1jntPL2K5GwmDCxoaAm5kECuuSrGbzMuYxda6lxHvR4CqUTccU7aAlfdtTUGMuOxBS6zQ1Z8a6mib/D29PSd6POj8Hg6mB32er0+P4xO+r1g84AibQro6njLoNffT7bKTCD+Fu1tScGvoFYN+lQng6/Qvy3VpYhku6qiWq+fJqN9rbl+4ot9oKkG1JTGhvuR/tqtWrWsKNy4QPDk7O5udOEqLltqqCoZZ20E/gohXxQwu1UBGGBvQrk56U9ckmLNhVxh9iK4toDBIYUH6NPzeYxKQFYDDpCoxGUhCgVvtKu2Fe3H1nv89CTqz474oH0aHor2EX/Xb7+bHQ/avegwfCtOeH96dIyp9zvT3zeO6d6yfv8de9sf1PjegWPHX81ffz1BJTj1aLtLUquC/ojU9CupqJsZ5AvUkcCPch6d4JKyYEdsjqmtNLWhVzklKAUFNI1FtWCnWgMpVTsaEyeY4MQ38aFolir8VMgruQ94NiL+BtpSPfAYNS7GXi/Dj8ZEgF6tWh4v+cr6WYRNCLQnNRvpJ7DMI8J5VjENqmVK7WAHi55ZJhPwHQhhb+BMC2ijIntQeHuPtUuOesxBLehS0dfp3avr3D85Oun1+297PVDcBfM3Vjzm8FOiIwzC/0z3TX2il1HRKQpU8MVRDU7V3ko6PjSFNTrYA80cngOBo/AbNH502X/dMqvihTHaDHWEytHni4qjH36p4W13b0MmQYs5xax01RHFd0f8PlwvK/Y9B5qsUuCF5YBFA9dmB+mbLXF0UfAuqq5WdWzxD4Cq6PhJ+GcT1GJSPCvBt8UKOKYglgs4oi6mQjMK/T9xFO6Ur7OfRbTjmuM/dYKO4DyjAP6RdwDy0zENH8EmALDckdTP6+CcpjH4+LBprYP3NKoiCNAvaDWf43VD4O8/mbsAZW+Ky9PhARzgOt65CiEu6CrQcaHxBjXVllzFUWBQGQkjJ67tqqULnlQy6joGwCtXqs6SfRceFyLR3lCEOBNXaEcEz9owZ3bk3HAgHFIHaF1dwI3RUR5SIb8g5pck3IJzkC+8sN26x01FHrYRuMVEdPlTxKFMBDcmvzRmeZz+mRJ7p2uVNwDbu4Wy8TvW43nRpCZnUtxpFDMqjNsz+Qz0wo31TkcG7BXQSXhiBaMh+SDloThoMdGZdxpiz5jf+B1OxOgOvHP4HpocJGM149aBuyr5QJe9YMff78e7tlWuUaAgrC3Uc5K8zniZUVOClR6k6icaRhu2sxbGLcACQZz4uL3Lv/xj3gliZsx0AXc8JLgDXJOYgzZPUzjpL9u8K8XIv25/qidsNdcbXi83gX/1E8xd+IoHzEppMpP4F6eA2sDhIIKo6Scio0g82LBkqZaNrM25ggHpjX8vc1B5MdPceAO9tDyixJ+bA9Qo06GOrb8zxuwXCvdY369dCtCtB70ZarGFjv0lCfHkFfOAVCHRFpg1ZXYGyzgMxm2yV4If3Asjl3be06Tt/eGQfRqyN5C3UAqjy/EHdnvRhm/wqzttdHvN+qe9/mH7mCUXOuwmF1dV4u7ec9AMC21LKEtpVxQ91Bj4ddDp7YRuuVx2OD3ugMldv9d2r0bDyx9uL9u4B6dcmcW1HCBnFTNcASaIuC7sg97gqHPY6eNexPKEq4o+7s1Yk/02K7bSjv/fXw/68sdr7W4aQ52iXygQa9/jPgdPA3epBF2O6Ha1z7k3jMrR9kavg7awwG4JItbrKbfizsSbDf4MQGSoQyPcGCoG16+LrkDNsRwz/TXbizH49qbg25uCb28Kvr0p+B3fFOzFzUeku7vvCwpGRXzbrRk67GqPqzcdZ7uj3XbHOYXx1bXVMeXm+haJ5tT/jxsJjXEBcDl8fwH/ngVf4D9CbyISNDri7+sg5mqe8zmud3KRQHJPZ7dU/pGovP+AeF08UquKlk1W74zBf9G0vVu+wxqGKvm+XO6evLih5MFuNcYCr3r+A/GAj+o=
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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: eJztPWtz28iRf2WKVXeRKyRF6mFbus3eafXwyvHaWkmWnV25xCEwFGGBABcAJXFdrrpP9wPuR9wPyy+5fswMBi+Stuwkd7GTtUkQmOnu6Xf3DD60fJV6STDNgjhq7bbOVOSnQkbi1VRFxwdbFydib5aN4yT4XeIt4lT9NlNpJtYuNh+JuyAbCxWNZeQpX4yUzGaJSkUQeeHMD6JrkSUySqVHT/oyk236W8jrRKmJirK0DXP54uTgSKTBdYSPpLPpNE6y7mV0GZ2PFQ+BV8TaQZAoLxMnMcx/m3bFm819cRBcB5kMxX6ifBgwkGEq9k6OH4kgFb7KVDIJIoANf0pUOBfDuchg1ESNVKII7CmADD8zer4aBVGAH/+QigH8Mo2jVP0U+2qwixB1xMAnKK6mAMVArBe+d9/fwbW//td/C/Ok8GIYOohgsNvpeXyjop+TfRyN8DbXNFEHYu316TGM+fzN+aOu+DEOfZWI1AMCENA/n4o4EaM4DOM7vuIrNRVhEN38m7iTYagygWCkGkUNQhYjJhrMWRIMuoyHdyWnAaNAHxdC73t70yCHc5gACCrppFPlBaPAE+lYTmHpRwDg/jiJJ4oQPJMjmQSPGFka4iSJs9iLw0FX4OreqgQeByxHCUwFzAdcpPzSfF2PRoRpYfTiLylNMIDljhDNSN4G1zKLk66X80P3WmVrj5jiAN+dTHymEJMMFrpAqpNXZ+di/XZjHZAfBdfrPnNYh+9ej0EwAn899YFa6wy+R7yzPg5SmHm+/sHlqMN7D8TjWh37H9dhAVRwqwD1lZhBJkqoyTSbA3LiYB/ZWoxw6a1sJFoYh7EPN2WpCkfCk0kSwEpEsX0mUKEPklZk53aRkufzKV1T97CimfJfJYB2lA5YQAcgKsl8CtdP9RiHkXchQ3jyjOVV+QwwEw3UgC9kVpCtTi5bAlaH5S0LNKcE0RhomaEagbUuy+jJAeF8Bgw+CCI/uA38mQyPYU7kiImcTlWC32D9prN0TI/X6y24gwXnNvCUiEdCipsovotEPixzZv5dTGbw4FjeAqQ8fBRndtlhRFi0rjiI8bJIFS4HqMVpApySZAHpQxFHdrUIk1Mlgar1jDJwScDU7opDYLW5gIFBVlyuEziLBkTeKGRsoPstLo2QKTKFmEoERyZygvrQQjoDfh8EPqzw3TjwxqgwJZIB7okAaWDWOIF1ISlCEWWuu4tdzIB+DCbdOwaFhXzHs8+BEggViIXFY1cMcsF0McbJwzs5T5njNddpih3eT0F5Fe4ajECwUZKIkA4MZJIGzw5RhDe/uAgTh4E6AUbw4sl0hvxahrKNPIm/ojgUfpyfB6jFCEQE2ZslwN8ZCQFQt9Vu2cU89sEYM/T7KCtK27k3hAEZZ//CgVyz98UmDKKn/AGUQmv3A31FwFq7WTJT7ZLBP1BhwKxFV1iDN4pPV5AIutQ5sFKtBTACPqMRkJTN9pUZFVmGlXHOF0JDTA5CFxDyyDRkiAxIemgW632KGHxopd5YTSR+ykCJAU7x8D3osFYZ1VNXWyKa1s2hb0xOOQyVOHFBXrOu0KMGoljVtJAuVp0B8ywmDSsgMK+wMPCY1BQ62P/5hYAZYbFQOrKCcwR6JwP3KTW6A2jLEoGDgdwEPEYcgQ+UGpUNFnBOHA0ssGgRdgFkZ3ZwSFCBDBFGYN8gAg9EM3CuG3A9mujhrFWaJQB2Za2OrdphHf1AgrWLHtEEDGA7J6DjoIoM9E8I8mZJrI1omb6k1Ax97dzgw8boAUutA9Mx0hkFSiLDg9crQJckMKFKUjNFBB/SO7xAmuHH8/MTsdXrtYHAnkQtHcWF1SA7G6pRhrKh7iUAjJTse5ujx8O+1+l5W087W8P+qLPj9WXnyZMR/Os/ln3Za33M1cP81DCksxzDOA6VjGg9RnIWgtCRpi2vzxsEe4AKZcCE1ASYyjRV6QL7C/53LghWExo1Se6pa6vOrZvGlALdy6OPZmFo/Z+c58F/7orX6MnhCrFOI+kOZXLdAFNaoCPiBFRyGOMA+KJOu0jfJ+6T4YnD9XVK9rzCZbGAp40z0qBqEfcxxwDkgYDuS+JbjRoNM1SAmnJ8WRRIzfyuqJCGehaYZ7WQzsHwq4hNLekF/lp+uKKzF6g51P0pygqKQLNsISULclMrAASP9tYsBGZsdygrq6TZx5Kc30FpBbUnC8wcNw8Mzy0ZuTKsdcZBk808DID1amGMm3P487NXL8UZWSrjNRVn0hebNBxoV+DKKC6Ka4P23EdfPb5O5BQ8O0EPLbPrzmJMyI+U+rlgJObxTPjavQXTAZwC7mxXXGxCWO1PY3AZiX+K6uj3Le/ixWn62870z/e9l9c/PzncHD+/RiRmCQgMYHa/HJHXpy8EmXciDDyyGI08HmZOzVyrAEsTkS9eCr4Yd63u0E4O2D/cup3urq8PWJ1I4QcjUluZgQSEF29E42SCYBbCZZRxh0d6uAHNJ1tGN3BB5MjIJ9cyClJZMY2sHeqCGMunK0ZNpEe+YMhUiurI+3fDOtD7Y7QHVcoCAc2Ny4l3eK+jmzysYU6BIVLSyn83esqsQM8vRRtMq1Fa7iwD/vuSln5Givg2SAN0me08oAdhIkM6vKw4wWclEnMYrGSWwbwfg4MVwGdX58kkkfPKyp7Ia0w+mPttaJrDVYGojQHy4Nf7flvM4b/7Dfh3490AbySAUl5rmk8zNAa4IMheFmIEMUsoXL4Gy1Uv8wGo+NQBXd9NPBtEx/zrFjLwff7FKopf++AE4n8b+O927x08hnZ0z2RPH+aUHBQysbw8GAik2jglExMMgqgXUg5KB8S1y6c9TI44f20OARAbjSqRCDPPxWm0d4c/kje9OKJofdf02/eteqeXieJYo5Jmpj8Q0hhvFMD89UOJiK+mTGywElEAU7iKxXAgCOwwvi9oEVQA6Nlb+prckCBxQ4OLuoV/G0NAo5Jc+FBlJDOdE87TP5q/KVi+z8zs6JH5tTC0tdLBHPw1Jnkz15E0OqkWelRBqJ3c5ybwsfBwWW++UFJHmYyQiGeZoUNpgNynMujqmM5SI3dYiVhyhtFBhpyjfS50jiFOAtfS81SaGpPzZsETEQV6N2peJLVJqzWspM3V6Yc5m6njQAdiUCYxLpuep4O3eoAtrptsWKBhoN1PvFnbjFogOOt18rqQuJY+KJl1OQ3g6fUP8O+f1RzT0HqEDoyAyi7NAD6i+OBt52w25CXQSTm2UiBZSCefczvG/Fu8HGIh9wXRTLExBdJPgcMywATWGofnqV8l1zj+HVYWtH9J7E6JUx42T3LXIkzqWN0HKYxNn4cqjLHgFONoSZVd9U2ITBjPFYTte5GYRTr3a4W2TR5AOflQK8EsPCQHZlAdYkQV94KhY6I4nmQRSuAFtIosxfhtJIOwGBKRUUG9w0SCb7gi8L1I2parg7VVr2TJtIv00XVNHz99uqP6csvbHm6MNnu9Xl9u+k/6vdbHdzgkp09IXYNNwn9Kca4bRPhqgQOEdEpBHzB711oXk195SAKwmI5yp/mRM73Ls4YXi2AT53nmGQJD7yalTP8nZhVduNqOQlnkOpYsZQoOXEFrOiGPovyuDfqN+KY6GI30DdaStBFNFNxS0a+2iLeXD8wJXY6+8xJAnuHlWhb/gqTB2gTSflcMLluXrQHnZAXzZVsMeuZKNJsMUTR10l9f1Q4sgxXNwnBgkrq8koK/kPu2LDmZp/hXiEmbDH2Dj5TnXWxVhlJeTcWfYrmGM8cSVIuvQC2jUYXvMFLgU+rA8h/rHrqbqoyUsiWjZNOeTPRiMPpU7Xg9ubPV2Rw+8Ttbow2vs+P3+52N0bbsDfveU39TUZC6SmjaWDuqhOOcYyD7HWSc3U0dZLriZey4NmxIUoeKHJU30pDzawkZ/rGrSVxVt9Efbg17o23AcgPU3JbaHj2WTxDZQoJgOd7LeiWwqA8uJ4xFBWis4+MXMATpNITYAi7ZxIWb9vtDatN61AOAdSVQfjeaEIAk+biGDwqpIwyyuuKQRI7IPEuxu6LMEpgJT8WabQbgArvtBnjUdcih0YFAMluBKHSbw8cmcbOEWG30B4mPYckSFeZMzrS0gbUtjVYhXA7cEWaPV1m2GFPa8zAGD+kLEdNdJfC2JkGaBmzGFtuhNwmF/OWyWcGo5ONZHThynHoyEFQUqa8GcXUHFmqiHRmuoJSpY3pD8kaDBiDaIo3rcnBaW4/BCSK2YPtTUJ+EpbQV0qZ8dJrJBOP0Pa1bKblNtzJu5PwJjNqNkeZxD46PikAb5eEOji6MLjAXFI0tAhcrZjblwMK7zORcpZ+w+M3wVpfcyWctgs84EoXKUsGSoW//Z/QDcI1yGqY2vVFELqfc1UrGomI/CwgelIoO7LLkyI5m4SgIw5RkyowcJ1eAeNUv3aMUDkxzYG8UP8kpdoURC2M2DQVaSW9sNA3Ig1MNRV0L9AljrxBsN3h3SJxStqqcCmpwUVH45AoKLG93E/yIISJ8BL+uAPua6l53xQBU0NWtd4VOMzf//DH1O6iX4Mskja8mfuxpHfV563ccTSHKc0hsPdnlK4srAaoI7khhSF5VdISWw4GFlRN0mdQ9ihcxByWkAg4HS8vkEA5NyeJ11FkDA8xVRHyxXFxfMv+QJ+c79EAD7sjjHal07H0C/G8hRJwqvZqpXrTnb84xQgdHCpQWGCpqDPzyTBNV+P3/As9oqL8u63i1/GKn5lWrpj31khBZNDjvVr1nFUpWgxCbSmwwxlUYiwq7okUJkHeUAgUzm83SOqgUxGY4lqnf48x5uvVKxyKEn2v7wPPyeYDCZQig4d53ZWRfBCPlzb2QagsAyMKAa/cy6nfzhgIcfLAr6jITS/w/9sRtxH8n0QAYL9ba+A1nLoOtnq+YDNVW9zrOqEEMPfoIM0bNNdnLaLNb9DwM3YoTkBOkTBec9s4w4eaacgg2OGebd69RONng3M3JW9wqz08LpGfXCKVcPGjWoaaEbiEB5YUpWVR8GXtJeVRW4CN07PkhVyLcwlWxvQuTILW8oa81WWuXO8B4coCFou9W0W0hKW2XFYPmSoOophgq1FAGk7SQJnfaqJZU/BF96pNV/p6r3DkbUqcR7qmTkOtvawG2NHhx5KePTL9DuY5jWiZlKvRENOls6v9tJg0lEAWCJlrhSnD0kIaxRT0sFF/WF7ZMFQZBianH8pWTof08MHItU5M+1uG7vwQWFrWqX7tv2vPJ81OZpDYbvmeIRkwaRSWOMM5Cm/4S4vG2dWTx03UMv2RdL3daG5xTzjV/OglcGLoExMHxASrBl1ROGCIOpvHbCwNUKBaZYCTkrQxClNqqCSOI3pUYp6ZW3Oh9N5dLP1ZiMMUZHNeDs2ktrQyt6GudgpsikAoUWLCj4m7f8MoOWdfExjO4Groj6w6pYraDlfUK+Oa5/rrkdoPf66CXd5dlblGc0xCY8Ta4JYyqGzmZMRoKAekNi2MN6npWF/Wv25ZHhbMEC6Z6m5Amvj9LyCWsTbLVgPWDTNXjreWiwvfNkpDTgziH6Q2r9M4tJiOthDEZlf76zxFaZwnBgZzhFq/cGcqd8ILO0p5IG6XWdnrg09RP5owoR9wVW7TTXbHn7AHgzQOOS2Pq6VgptLnhgvGmjAAmlMEOYeYwaeetfhYJAkonjrgflsc/JwItzfUi/cVGt+dsGnLa9+o9OcdRvp1ekXCRe20/ciPQlRmSVFrgk5Svmn4WYAwizP/AR3owD6WM/j1xU2NEmIGLPBV8BwaqgY7qaCyt+x7YcKIVqE6o2hDQwFu0Fq1yt8vnsXFxv2EhDdjc2FJ0h9LVesvq5k7Hw1jCfDgGGjynt4y7K6zrvsj8FzeYrOAKc7tWzvu4q2vA3ijCVtlpRr18rN6kCXy08tW9/tikIZFABMKigAmLVeQKhwHoJSunqdkw45bCDIBzreONMEc8glPncsbRO4A4mWw3ApXpRHttPtmBzf3XnHj1CpcpkdbuPLD4WQlcsgBdKnbaGU2tQ9dSaapiD2n/ydaTXn97o9cr+T4XSLAgm38lH+iC1yOwNedak294yYGrnRdu8o48irU4mmIc+YoNpGD949yyQIhlOKzKFuIONw9S17K609TH+sJqDhU7ncc+9Wev0l/NTipoLt2cTDGF9hlsnKvJsCzNUMii5Lt0cVJKy5jxrmSWIZsSDO3W/XZv5yqV0ZUfpeYrMMyYbAcPgxulT/WQr2HEFdqtj13Hy4DDfStksnF7sXGF6lMHX6pO5m5W/ZQSbGEWuwUcwRiD3W+GmzeM02Y45e9Wdnrv5jeSDb0NJHfl0HbhQlMGFW6LO66J+7HfTe+jDaijv1PdPL54GrsLF5sIpHj+5rCwldt52GIi4lvtaS3YLe/sIzOAwtgusOBdTKZAMIwUSJKpVWvAzbS6NWQWma/VncUskqkLbhnfzwa5iSqBTDq1a5eNk3h2PdYJaGAQdLRvLWOkpYabCm3Ki2gmql3Bz52sFitHVzic02q3SnyEV4jI9oO+akB1PtIv7/JcW7Ln6JmlgndhtJ3zFJUtGPnYUbltzPzdGu3hyIp0BbL70C0R5OyX/CynCG3zlY3tVbp/tNLUX9BsNhIxxtrkV6sd+19gj8I/CFp210HVO/+796I/cHsUWfDVLDYSU0UpejAjsDbjCNuMUAOCw3PLQQa19YC9xo5AppXbNrccwialZwOUqR7KZRL2iHFXr1nJphRokLrnNCBha000KBwrWmZToZ72ViaBjDImm3XtFunrtYWHczxii2sb8Du3/Y61J1xvqF8L7PiQVEyYRbnK1HpHn1ICKobxY/9RX8XQBourU26ayN1upAcoZvRDZThPg5SbzUbUpkUFP2TSdVR3lLHBbogq9KvBrnejlFxHANh0kmvkJB3OEE8lVv2YaZqRPEE1iy6WdUWdbneS+FMIciaAhelIg3X1Z15u0eLkuhOkcYfqu4tQMNnM47NXov+019/sPBF7UaTuxX4hjCxs8MRA0i7V/g+vTsXgsHy+CO6rfIV5CtPPU8xX0BEmlK9ocCKLxrKWr/i8hfKK4VUHe3anHXdm9XMGdD+OKRkuEI52vnmU18OwaBDZCAg9wYUiBBjbekDleB6Ht6m9oPacni9C8mLJgE/uWaHBqUFrFOHOwQ5mk85QUtTFqLKQ2tZaEoAkHTi7cqcrOJWGXraLp9TixI+tjk7pPAXiCuecjSZUahrHNEJL98HZVqeaqe0obQ7ZGds5F4qsapeu9Qe7XLeRraFANP26Bk43pdSp2XaT7XjkZoaWL9z5CubfNoSeWd5CcwjMN5xbuMmeYcGrwSpYUR18EJcGvsvWLnz5jm/qgBf9/WVLfMSd6+xSLzAW3fr5HBtaKBbS8Qn16Gm1xVuKODNyZcpx3AT0W3hFFWz8Rt7TwDlc6mqiT5eyF5DiWjksSDV9NPvt+EivL6oyWL0tUBj6GVdffH3pr4eqMq2B7SGi706ohV8f7YbCzzlycmCZeT9B5P1iFW5Bp1WHf6Ni/2LJEmsMqXVpBJ9Kljq7Q2j7oel5fcSdzUrX0IJMzOnMMw5nsMicmwGKLbTp0w07fCqAJtVgmeSuILDLhdHKIB+es1gU10qyVCdtVg6L4lmV37/+5/880qdJ/IOq64+5LtC1/vTQZlxWqH4cQ5Ts0R5wcGCysVq278CEPHqHYE3iRbgFlTqHqHwEZNkzsluXVhjBfXqw+h7+6p59nrJdSrrrQkcqxoHvK+pkzrfEp/9Y+++/yhb6UaB3nC/E5wVVr0aC7hbXKsJCA8DttAIUt+3lh55qDFGhGr6mAxAgmpjZM81WVK+5Kn9wFR8CydjjbiMdsAMTIHq05ipJ4qRuBiyfYINIfeLmEB/j3UzByJ7hihtXsQ0An+UzC++C1JnnwB3jU6c8AF2GwwsaSkxUmiLvrTY9L8dRENamiUwjdUvXXypn0ThMrRfVEtAs9UPHLrCMHp10YaEdkbZym8Vezhhwe006kXaV623MZtcVTk4/5qpet5UUZz9asef8qNBoblaINtlT6ZAlFRWgvwtXWflhMWvQPc74UCZTt9GFO1CecWhSg4xUNi+2fWIleQARPGUkrp5cYavt/ZU3EBEfLsvjF5LpNLuuo1U6yvJWxLNITtNx/MB05348Xdb+KXR6lw5Itcdsmp6AUhtcUG6wdlp/GjoZF/Ra1m/4q2yyK2+TtG3iTteubV10W1ndDtOGfqWmjiqT4i117eTNMpVabqmQWF/laCqY1jogpeqEk9qvWOpqB4ttJ6l0ddS1L1S2DNTtYC8fpOKekr3m+BWPaKv8bDKRuO29VThdunwecdMx00g/cxRLw2563L3QvLm2kU1X3Im8qEV4tRMQK7t7C6e+/Lt2mAP/T24B918298ZZNk3h33/ZOIL/U1Nb0tV073rxBC66Db7w9X7+O/ytT8b4V+eEwz89cCz45BIfvq5COxcCDAjGsf8nXQosb59dkSTdbreAFnxvUB67rW3/KUC1M+wAO2wBhD2AUAKswB7DTbnlb6vHo7Kw7paKnOU2jXK/RF20oE+/0JWhplPpmtq9W8A5w74CciKMwFLbqvPU2xl1erI/3PCYr3PNt1veB5NvX9Bw5J3c+uCOagdisUVQ9wC2GjQX/dDQ7dFq0q70S0PLaqtGadFF0wbXKitAupKXN1tVNWiQL/ex1VzWbVt5f1NhDwRf7j/Gy84uhfwyOUo6Z/DaOFJrHEuV9J8tXNuT5zHZjqcSLD5FnvNihZMxHqgVny7Sin0J8uEB76GAdJ7Ip0PQaT2QG7UxAp4cbnuPFxrzz9aKdWqhUbpHm2rD73u9znBHPu08ebwNmmij3+uMlO8N5c5TvFIj3aZF4WsKdqny2lgKKtd48sqFk/dz8vC/uunuxlGdxHMhh1MU80I2xyXMCtiZbE8xWmQAietOANw46phwgVmzgzLfOTk+cCMTu70TBVpxXu8WFoF7d9D/4LGKQ1Ef/jvqosPdTkwZ2n/5a2skJ0E4vzLbNPIfsLgfmev4P8MENlVF+PAlrSoPdaxgJJe48UpXtK7sMQa0ZBYTlHn6dCXDaweTw7ON7ce41fBm2PwrZaHeFZPSDjfkmdnVmIHRan24LPLCZWv30nLDZat9WeQH+pk5gn4knqCL9VxBN+V8AXfChA5nXCK4l8AbNMZi7qCxmMIaDE1X+gGXiofPuQRHv2zkk0vkgkvNKRoQZAl+yuEWurHwY84xl4ZlLss8o3HNuYaALvPNJcRPrY+8s/Wb2f9HMvsPsPZnbOv/KGwngbH7mIEt2X59c33S/fmb83beAauTw3dBGGJy2PbYmNzwA23/ziLbvzN6qp74j73O9nBL5ga1YywqXvn72/6+/tPZgD+dTfjT2YI/nW3nT5Pt112Jn2P/Oa9iDOTs4n1vuvfblvfL5OBmY/7i8en9D7dLzf/XMP71pt9QUc2fj4fPvOBV8Pzo9e/H/ZfBcXo8yaa/7B8/Pn5/GLzYf95Tb/fw99u/vL3oyf3+2H97GqugP//l7SEIr987Du4CdXDx/vj9dHh8039+9voYIi/Uil0Y/v3wWRgOo9ORfPMzDjP/5c3p1JtcvPePdvre5Oax/PG05/340+MX852NX94+n/4yCUMv2A7Vs6PMe3Yfvpi8vB2eAVjR89Db/OF2GL0M326ebnvPXuN4G97RTm+4kYXDoHTPRv/2F77n5i/9nbH37GZmwB1OLra8ZwDDs4ubtxs7c/nGnw6jn4JXYRqsBs9zH0hz85fNo/Tt5lEf7tsG9J+8CLZmo7e9rtU8rQfb61prbYp9l19xAS0OYJ++maf/H+aJFlEfaArkxW9bfHDmykdauuk/qnjoZGulkPJu2fbt/OlqOc2pmW3RpqJV6jT5sQ0/SAyf8SgXe+BbS2Nf7a8p7IPH0gOfwsqFSi2uxgDzyarUFKzPWtXpf31yRuGND43vpcB2gcZE+1jqjc7uKbB2bB8ARaZL8y7X5vdaLE7p07kfNTgmasTVFzfFX2Wb/j8x27yOzB4BLioUSLP9Ty1R9tBNvRGApim+XAVfeVJowOXD1PjUEtssTuxOBbfVXjjg7q12XpngyDOwe90tWlybXgtRWl805soDPxA3NYLd3qNzrOEj5RN+oEO+0ZGnK7hi8ppCeNOywm9My8/b3X8EE9gUwjvKdIxjNBE6y8wpitbnvD4Od06goSG61x0Xf6AmsV6WFh09D9eoGLC7vu7Dbx30iYNrUDBZN4hbiGGpzcI2ajcNs2wEMH7X1KVQ/3jKP5cBeZevAjvpxP9mLfJeCr7QcEh1Id5qVdrXzPnppV51ek0obejU6nVQGGdgToQ3/Tv8ehbT5TBgGMVArAGvKaPAg5BoMJWeetTmg1GKw+4K/eB3eJ44kgNPbP+eG3JcrvvQ4oPmTUG8BfFjFTfnEHrT0k/g8UjmlTJBVIpJLQVTExnxZC2rmXDdqB6Mek5HMPjmv0OjSRa+M2HF+LD57QnV8zg+rpC1bHznQsWJs5rRceXstQaHrrZ9qdIJVN2/RGevRaPYGBNAi5T8BLgFp+UE43/kUmEZO3iWXyqKkyuJJZ6wD5m+7NQ9lyvAfyfWiygcJlQ+WNztyjs2x1ysvSJtd8wv3/3EE8lNcJTqtwdSr1+Ez6Tafftd78bHgzGxftmm9gw+N5Z04ty6Oe6BObwhGJRM5ONreDuEL+0kojfbslBoShO02K1/sS/W8OTDtjg+PD8SZwfYaQlXebZ868m2mBzE3vrk4EX1ZB1qugKnQOkDc4xKAg0AdN3o9ipLd3d315X0cxdQXtfPpusvjvcPX54ddvAZPPolyMICDxCxTK+XUXVoD3jZN3obW93Nbp8aMMHiTGTkwNP8FpQS+zj+zreXdn97afe3l3Z/e2n3t5d2f3tp97eXdv/tX9qtPXF869b6NATNq19ySb63rnff4ou5GTFKjbqotcw+VHRpfa6IuAhSRBnRubhjDFFhuA8fcNfQ6yT8+BEv6waAX99hMSoJuHcaA2QTglEkGqT4g1//nj/Xn/j2UrNvLzX79lKzby81+xu+1KxWh2JHfs2rzXS9vUXJLb5nn3VXR3eDmzsqeeD8iT1axoX3urlB9C/hZvTZUFfqPq1E3mF2BP7ebeErrEiTU1xMeWa8/qEVghmayWu8n8fFPIOcFQ6oZ36Gx/UH1Nfmp2juQFlOoTEy+DeiVvvIdyjDICXf29v5l8YHbNKJ78a1wGrk/wI/ADIE
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

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 verifier global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-digital-wallet-open-id-verifier-global-configuration

---
id: config-create-digital-wallet-open-id-verifier-global-configuration
title: "Create verifier global configuration"
description: "Creates the global configuration of the OpenID4VP verifier."
sidebar_label: "Create verifier global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWntvGzcS/yrE/pUAelt+xCiKOrabUy84G7GdFGiMilpyJca7yy3JtawT9N1vhuS+pLWc3vUeuAYBrH1whvP8zQw364BxHSqRGSHT4DQ4V5warolZcDKP5YzGJJRpJOa5oriEyMi+u8p4OrkYf7wmj1yJSHDV+5x+Tm/hVXO95kaT5YIDkbKUxXpCw5Bn8JKmhKehWmWGM3KWm4VU4u+O+APXmUw178AiRhZySWKZzpFie91vOdeGaENXmjzSWDAQJ+gEMuNOjgkD5ZxkTsULMReGxp9oHHNjtWEfvWTvrN7ndTWAlXJ7vJVsFZyu7a1QHNgalfPOlhlvuDEinevCXClfVoq32bUHO8ADw1OD3GmWxSK0b/pfNLJcBzpc8ITilVllHDaRsy88NECYKdTTCK7tujzLpDKgJgNugsaXzrrCsfHEMyljTlGxHcmJkWSKWk3RcelXeK2Khuf8ZxbUEAFkRPlnJJGMo32mDOwYml8zqU3vy9JMiVTwMPyVZsLe98jtAki9litkk0A8UCPVCu3Gn2iSxdx5YoPm4Bo0tyL4yLh8ymATPalbQIC151wBg0SkIsmT4PTgaDBAg0Q0j011W7fPexFxIxIr+bNxKDDuwZ1Mo+wcbhQYkCyVcLklbJDmHC2N1p3yp2xKwpiKpIgYH26ePsEwBcaOCshRtAbvXHP31PlsJXMC/n3kbrfSdjI3DZMhxWbTqYXzL3sD6H5TI34h1lxi7PeG2x8lyKiiCTdcQRD/st6y+pW9oHGP3KXiNzSB3c9GpDeYhpCYyScInjlNhXYOAfuCYUgklbNDadVPhZFANubeLThlXHUcMzCqCMELeeqwsAQS9K1xKGf4kykTHGRnrTKUsQ8gNqciBS8iwdICjyOH163SI+il0jToErhsEPMGTY+8917nXiF0eWGHLQYlZJfqAoWuW4PINF5VEUUh2tHugEyggTALyOcZp8rjggZa+cDTmnlbKCBprifkga+apjb0wdedVltESib2rSe2xhHzVCrekBiSQqLb/D5dXBqCtug3+oyDZsLGALd8fUq2CmEVmF7f3ZL+46jvALxPGeBHH8AKqPtr+P0rX03Ypu85dIHDlKD/QD5r8enP3Zt85lwwYVNMZ9yRcUgVtBOz0eS8W9erZiyMPpHmqLr0kEyEAU3A18jebX2l5sh/CZsTEVXhPpOghmOrqxhoUzjJIez4k9DA217PuK3AsCtwU7vh6hehMrFccdYjZynJ04dULtNa0mJB38rhdueUhQPzoGDq2oEmB7vOSeeMQpiIIq5gwZaUEAsJxJrLYryLqIida/9ye3tNxoCsAJECcccZCe7QI3DfNG1Qx82IxlDodqu0Ngo6gaCOm8HRyckbPqTj8HA2ig4Gg8GQHrDj4SDY3CNLVyBtMR8NhvjTRMMa7Ie2mWHNGv1vbjAe9/RJLcRN2d/9vqaSTAz0fTHzyFC0VdbbHFat/FKnSoHvbchoK2RvRxnBdn21LfMHqOWKtdSc/Ravl+fEo1tZ+S2mCgT+Rw97yu5iNfbx7nAIoMCRUE2me2wPqd4o7cHR0WE0mp2Eb+iQjTkE2YjODsYhw1jcy+dlizxbhV+wyJ32DUk9c6WtOx2SZwyrBNRqxgEaed0qDcVmx2wYjemoexIe8O6Yvhl230SHo+6AHYRH/JgOZ+NDVFLatv6qFgRfo9tkRynmZoWi7DoYShBZbBwW8QlqbaUcyPCvdeO2jrpevPPf78P/+V47zZOZxdH/2Wba1RRXh237X3bZO+0yAKlD3TPzsoqQKU8EdYTZNMlqylSzVQkRjLdGUW3/4fH4eDAcOilcvvzBUsQULBMuaDrn7HdIszVCCKyN+zHmmfTcnzEvBFzdM3X73G/Lt6+E3dtxxLdHYFq8g54AjfzVBbS+F1dKqnNIMjQdXl/UXAP1fn+xrajbJtfSFWMbETvsW8CugtG3FGpamkHLWM5ewcYNY7v9xkyyFVlQLExkusdFgFPTfT6y7a5LQdu0pT77dso1LPN9Y+cFEPbVEtjL+BG7Q6naKBSPoAVgxfTWjOltdw//xO6+S6kHYs52THP4p86ECeynUogpj5Z2my0bYdHnYQ7laWVPMs7sRAiX95vOOnhrx2WsdPYJak3neOQR+BNJ4o4kyauimJ+/hg2Ks0k0E8i3kHieiZUazUSRWVAbSX3kd13k9xFoBesXoNd3vVk33DrhdDq1Hb9c8ER6lRFXVYyjkTGZPu33GbzrYosg5oqmpidkgHo2GVwryfLQHwi3snmJww2YCdz2HLl2r7cFua98cYMh6SKp8EgZEm5of27oa7QlO6W1PI+oTjrK5t91GL4JmTb4TIsTlmJiBtCMxBPgkztkcDKSKXkF2OZaYaNgULU2yGjIX3cI7817W2xPiSf8DudzNAeegHw/tb1oPfbWgTu4+VGqhEIeBz99ut3VrXaoA6mhdSGe4+Rlxnai2bqVFrQ4YBtcSxCUOY5+CzBVEDE+VEfrl3/02SL6NJIFZNHQQhZgk8Do8Vv8UEVM6XTxrnrUDLV6lG7ZqyTCA9dHmHGw0Q4lagQ+FPibFPI2h157ROmSnM5iTiqtNZlondM05AAJFg8mr22v2k54XTNJhSHXr1EiI0MZa3+cjnHLU6TRvvA659nTEwFbwrSAk41rjC12rMqSGtbEy7WNSYNH8orprtVXgB1IFMuldgHjLW2l/XRwTj6ek1cQcRDEk8vbH8nNRRfu4KnbbXJzRYYng+FB95AkFzLsJxfva3siFwhaO81D6eEwxaBXi3SF7AC7jnqDHdctl8seta97oHLf0+r++8n55d9uLrtIA041wsSNGLDGYjLMS++59lY7t48Go3HvoDdEWsTkhKY1edz3pv2T8Xbm1Qrs/9snOQ8AeHjez2BIS9Fq1k1rX8mgPR+50yoQGi3TqGZ+cGhMGHDZWtMA/hdYI4Hlej2jmt+peLPBxyCcsjUZmFBlU8dV6AL9bRGEXhReVId7z/ro2/eJb98nvn2f+PZ94j/4faIVRx+wrd39SmH7UHhh+2q35txhV/cW2VQrdoa5iuLMunHv2vpwcn11gw3lzP9/icQOboGiS/xqAn9Pg8/wz6K5bTvssIjP10FM03lO57je8cVGkfq2tWrZH2zL7i8Qr4tX6aom5Xb37pTBv6haK8l3mMOQJd+Xy92bZwnKftetRl/gKdI/AF4bkfs=
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 verifier global configuration</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/verifier/global-configuration"}></MethodEndpoint>



Creates the global configuration of the OpenID4VP verifier.

The configuration sets whether the verifier accepts an encrypted Authorization Response, and how long an Authorization Request stays valid.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

Settings of the new verifier global configuration.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"supportCredentialEncryption"} required={true} 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`. This property is mandatory.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"presentationRequestExpiresIn"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** `>= 3600`"} schema={{"type":"integer","minimum":3600,"default":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. The server uses 3600 when you leave this property out.","example":3600}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The server created 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"}>verifierGlobalConfiguration</strong><span className={"openapi-schema__name"}> object</span><span 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 is not 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. Use this identifier to read, update or delete the record.","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  \"verifierGlobalConfiguration\": {\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 body has no `supportCredentialEncryption`, `presentationRequestExpiresIn` is smaller than 3600, the organisation is unknown, the digital wallet deployment is not resolved, or the digital wallet refused 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={"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 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: eJztWutu27gSfhVCf04COHacW9NgsTiJnbRu08Ztkt52A5gWaZuxRKqiFMcJ/O47Q1I3S2mLLs7iAFvsopUlcjj3+WbYR49x7cciSoSS3pH3nk+FTnisCSWSL8iCBgFPSCpFQhYimZFkxrOXUazuBONxm1zVX5JUcw2rhSaxoRlTPIIkigitUw70P9od10j7OEm4TuySjY/Xx5u4sHSWkPBV+tyepeIplULb5WGqEzKjd7yJN+LTiI5FIJIl4ZKOA86AhHLPRCQtZJSMhtdXpHO30/GVnIhph4mpSGiwZal1VMSlYKP2nxJPj7mOlIRdMxUwbU4dUa15jOxcqTmXI6Im5v2aCpF7UEiCa0ANRHM/5vD2kksGvBAlg+VTgnstD9iwWhwwMJVltRdzmvC+5ddq9AK4HTD7jMqFnTH/moJ+TxRbekePazbv84SKQGc8l00OvMTOI9qOjIg5nJ7EKW8hCwmXCZKkURQI33DXudVI99HT/oyHFJ+SZcThJDW+5T7yk4gkwBeW+wqrYLkIVck1bvQDAQegvDkRcCUhp7CyKkXPrCRgdJmIiQDTT1TcZASy0R/0wYXI9fvzzba3arlDruPg+6fAHvAdFikBZ1UVVrjohVlNgxLxYToG9bzmyyZtUMaE3TEsCW9VXD3ekiFzviSvPr5+ggEjuB8vo0RNYxrNYMMdj0En1jw2hMBd74SPzjxxkYrPxkvIYgbuaULXsoiuysMoWRqBhD5Ok5mKheZls4yVCjiVRmMTmgbgFRMa6JoIl9y41QjFG+ETtdQeuD2ybKkU4gwk4Y7vCwwPKrMdcH5ltQ+fpvDjycwC7K/KTvxH4V51O93AUn5PwwgdteyIHhPsCCxw9LDDwof+YdefDu8PP8zFs1fjNH0Tnn2OPw6nn9UyWc6vv+zy5ddZ0r19/nqsTz/fsfj2/s3tu70kkrf8+Un/5Oohfdsf7s6lPPh6/uU0fmB741f7U7XT683U8Jbtvzh+ufsQnb0a7k/SxeX84OB6f/j14HR2tidfy5cPffkgT4eHk0/Pn8svL6aL8fGsq569uO1+2t+5YrPJs+u91y9Pzt6+fedVHN2bJUmkjzodq8G2E7Xtq7BBGaCAeQJ/eac9/BrfoS9u7ewfwK97eD78PNm9e3k2lq8m5xH8NR9+OXwxP/wcd+W7r5Nt9m73U9Cdv528u/sMO5DQ3uv587PFzqx7Hh6MT/x3/P0zfbWdfthdfFp+oSd+n59NX4pX8/Pwbd3p0HdWKzRmRGMacixYYM71xJbHIXoCuHY5ObjQ0VSysbqvVhRwSiwKNn+YAmbiok0+YmAsVQrRAwnbfJtxCmWmZYllMZVKG1B5wobYNC9MwrzPM4cE3lkjD0iQYuC1CJ1SjOxypJvt8LmRe3hHpEoq+0J4rGyu1tA2OedZAbUCEZUmmR7WCEAVtHWwSCGU6bI2bB1bZMrCcEW9Q/rhFkRQMuY0hoXU97l2BbGk3oYdkhwPB5j4qqpO6Nwlr0ZdTGIVmq9us1GOmEoV8wrHBhOA2dw5W7jUB2nRbvQJA42F8QFu6Lqi3ciEEWAdYVAWCtmhkYDdnUf4G8JswFYdR2ELKIxMRgf+jMZHn7Yu07E1wYCNMCfjiYxHMUc9MeNN1rpluUrKQu8TMkXRlVF9lBgENAZbI3l79EU8RfoLOJyISeHuYwViWLK68IEmgQ0i4/cAG1r2ecwDJad4KlCL6+7qFqEwgVoiRDuWkNPnUi1kKWhbaJ5qDDcbJwseEwcZ0ZY5qkrBrLPcWaUQJiYTHiOSqHIJvhCCr9koxl8TwEzWtC+vroZkb3sbEZLAvGOVBL/QIvC7qtoKjnIlsoaUHPwo1yDv4PDwOe/SPX9/vDPZ3d7e7tJd9qy77a1ukKQFpQY17Wx36zCvCaRn4I6zdeiHwvw0vKtiuEUB777FlKnh4MsqZtYujXDeAEaG3D2FKb+BJsUP4Mh6qchwZJ1PKCzawZY7GmBT49qBQmQMpYiCl+SVqoQKfw7XNqM+yIvLSKBrQpYjBcQ1PDLTd1kSy/JuluKh5GLQ3/vQG5gIMe0D/Byi1hPlK8yCwDf1kSP9P0DMpgdjRs8MwgIAJ6CQEPTsZ7Dtb8NomQYBdnx/A1Y7LkGRBk0vn+xf4XSgAP8PFXSFWmci/ABwLjNlqqGFya06NIafOXC21nU2Ktp0x9/Qxc5/dFYIrA2rLesPO2K+DVR11dAzlox5gfKSnfY28d3eoq67RiSPnFI3fIUxju0wxSkEvDN+SwPjnUyZpL6IRYLtO0oeqGmTRFdGmu9JhasyKfx1CS0uMe5n885xUqKIGp+aPA/ChjSxrw72mlLKPUlEiB4SRmQDQAXIqiTTm6VeqzJqobqUmw0HacT+SQ5cIkZGAgrVOVQMs4/lpUhvfY4ONQxoghx8X912PYnchgb/sZDFln7jGuAEMaRUoTTEwQh8IFYCkio6w6hco0dVsMMUt/UfqpQ/N6cYclg6ipoKVKsCDVCl4FzLH4wKJ5DItrnhjk6xYEIcjJe12uFybnks1jLx4tgyIDSKXE7BNA76XZJB9Yg1Qxj4+H12B7UyUh0UGCy7VnydP+RIAVmlla66zMgbnlDw1EZc8PMZ+jjfSUJ3QDOfueIbtFzv/0XR+ZeGAFjX6hVnLYHXEmhj/ilnjnIMfyOGvuGNdYM3av5mXcwSArsxbbOD8WAj/AXY1Yw4fhTulUnzOFZxTzEU1Tz3S3a7qaO0KiArdjcltTxMgcFVA/kGby8i+4RCpycjaG1y5OWt7NCgDkGzyddYsWXWN0C2ENA0jNb8YJRPw1rEAcNKp+B209qU3KurvfsvVvu1LPBLTTX7/2qPxKiPMdVhLYNMbY5Z0xFsggqeYm4wk69jM0GAx5tV69E7MeMVzFbmDUpNpzgi89xNQQYONzK039uEA9YQI2oL2JwpnHpGShttUaTpfe+uxI0VtzLvz36nti2zgjXN7Po8VE5uTJiVUSWDb1s0Em0B5UombaE8FHYNy8eKpaZVeYrM9yhcgq6wdDyxXdvP64zcFAa5RL+07pSZJfcLO+l5alLg6suD8fNa8c6HWDUY7bBNVtNHFTqjbCyXjVmimE/EPU7PzWTK8khGZAMSl51wQMEUgdFBRH2+2SK8PW2vkT0ibuNvONRBdeDY7PeRwQNlB3z07LTvLMOo0DjUZStNAiE+tM7Ys5QczziPqzBBcg2aZGD6KbOhGBCg3Uzhx7TxvrgIO20c7udxW56Vr70sd6G1vs5MdPCtnKgsh0FbZnJLCFpFcoBRVJz8t/Ce3AHEi+JV1e3KHrumu3xTVmxM36RQOmyS8O8Q2LYKcy5i495guQ/mcsjch/byZkuTgdapuU7acNOBzdJ4YH3jMOY6PyJPKsPNfIagXbeHPmwvX7Wrm9aQOr8Zbpl7VTutc522SzGlXlBDl2n8E1pzRmOmt4y8AvRAJoFaaOs8TtOG24+7PfKhRzbA+8ChB6dXZ+Syv4VN7IeePW1weUG6h9vd3a19EvaV3wn75+X+0zZZGis52J9LbZwnC12IFNArdLs10y0WizY1n9sgcsft1Z3zQe/07eXpFu5ZFQOswpyoLKb8NLcekMa8ac2+s72z195td3EvZueQyhI/9mq1jI3XY65UX3/d+/8/3/u7RIY3Rx3onKFyrJyLPbp6/Id3t2MHtiAF2rkih/2nA1IU7UJel4s3xkOgiM2wzgPBx8cx1Rzy32qFryFtxgZegAfSWNhODcFGVsNMKQfboKqbr37L/vbrau7X1dyvq7lfV3P/4NVcYxadI4irX9AZNA0fTHdg1/Rs7tpyY51sRa0vLXYcGzN+c225wRpeXCIsHrt/oxWaHtSL6QIvDOHPI+9P+M/kcgOYTN+L7x+9gMppSqe43tJFuEsd+C4aj7lpPNwD5uvsk1yWuFzvQaww+CeK1rjlN4xhiJLf8+X2y5MbctRuV6MtcDD1Fx8CXQo=
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

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 organisation admin
Source: https://docs.igrant.io/docs/openid4vc-api/config-create-organisation-admin

---
id: config-create-organisation-admin
title: "Create organisation admin"
description: "Creates an admin in the organisation. The dashboard uses this operation on the Manage Team page."
sidebar_label: "Create organisation admin"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/iuEviwBHNlJM2AIiqJp7G7qsiSok+ZDW8C0RNtsJVIjKTuu4f++O5KSJdlJ3Bb7tLVFo1C8h8d7e+60ChKmY8Vzw6UIzoILxahhmlBBaJJxQeCfmTEi1ZQKriluC8ktrCRUz8aSqoQUGgTMjGsic6bsFiKd2F9U0Ckjt4xmJIen8JP4JFBasIU/YMqMPY6LOTc1/FHORMLFNKrWR2TCWZoQObHYTlwbutRkZFTBRqQQhqe1l6mcarzBRCq7OuFKG2J4xkIyZAbOoFovpEpSpvWlnHIxEHScsmREjCxB4SmFvQ1UBF1wM0PFB3f9iNzTFDfBcp7SmKGOlJToYdAJKtNECZg5lmLCp87Y1zXTnuMBsFuxvwumzRuZLIOzVctHt5UmoFpsMUIvwxUDeNS7g2cYJgzK0zxPeWxP6H7RCLIKdDxjGcUns8wZwMrxFxabBtDHALbwFNYEzVjwuRPkCi9iONMo6d5uILRR4DHYvq2w3QpqJwpM3XBhGKw9/l5AkyJNCW7fBnnMmzXgsZQpo2IL+X7GhHd4p+bqmD7p7oP6ibiRi0PQZA26sAea5SmrWSn4QgULdQY4r/3bMJZZadyz4B28J0N8Hzx1F1Rybc8AU+ZSaOeLk97x7lDRTM05hKSLlKRus58IkmYgWLznYoknsNAIKICZSYE/FbglSvzDlXtHC1AVMtrphJvbFWE7InnyfBTdCQ7ZRXiC4FBSVFUf3DXWnccDG3ZmFMxV3aMJbfP3F92M9v3j++3O2Lahbe30LEB5vt1ORJGNmUJxnkHxjX7eNgBtoSrMO7VH/t+9v8RStROFPRimBE33UW7g9z7pOvfOLG+UnMOz2gc48jIk90Ik6iOWj8qNPIdsmYJJ2wBXRcYUj0Gs8pzWfCog3RCjxLraKwr+KDIqjiBbE8z4RjyUYK3U2JF4LVq3fFN4ckabNRFIxsxMJnorscsy9CNHlLJkO5GbLPJolbZVTvIkvqlVwx9RpS5PbDl19bxWzL9DrR3kARfceQo0RR6nilRol2xOplx8/S74UpjMKJCNlcY1rhqctPu6raCRCnoPG/Q0HTzEMyr2Kw8bKVKK1WKea12ATvx3RYUJuSTn9RORgLwwOhZdu13Qn7dGBCKx7VF5vQ+kcSyh/bO2gc7LAdeaSjSAa2K/VW3YjxfDOlIbeb8kv6pldRPN/+kEp47R96boRt+mFPhYJsij9rlfOx1Y82k630jvKn1Va3Pa6613wO+4eyUSvKEQICIvDJQHBTYwmAzuvm3jY7xKxb8x7AtmUA6ZQu1w66+93n/YNJHwPIitHUSlPaZlIxDSLC4UsBpcehW8YVQxhQkJv35e4z3pVKM9+nwKOZJWPe01JE/UP/1wcQiQdnJzU1yGlgY5RxWgRi61tQ9FzKA7P+lKYSfCbn1a7FI/0zhltdWmeZ8+y6S/C+wrsKUIZsbk+qzbTeDdEc15yKe+qkC+tQGA65MittX+EZjnEIZgDSwYj4hr97qtyOeNkYcYay5EznP+J1vWfE3dAvQmeJTz0qbtP/dhXpJjq6O7ichXtmxxqBuR5zQtqiIyauCMiDuGZAVMvGMGnQ2b8Aeozpb3Rk5HMiIHQhpmAYyCntXaIIcJ9rBDWDgNW7BnxAu+XMpCoTmOQLlXIzt+1UNsFYztb2/Lfvnd/e323eIYCcrIrzB8YbdQqueQvM44fDWUIJUFbYJbsrACQZW86LcAcwBLwfvNMD3YnsqqRPTuqH5/ZgJDb05kWYVobBqgRZ5LZV5vYqXCr9hxK8jq8dmy1IZSfYeKJAfDI9wFvMfxJ6an//biAsLlsaWsD9CcTrjtJjcMrkkEfE0FjIYH1zbho0MYcJNHBG9glKmOqIrEzSFqZGQsU41BCf0ORqzreXSD2dDRrkXokJlMk449bI4nLEnii1BcU6/QNhoNbIOioo/sfTnYgUxSudAuVLylrbb3Ly7IhwtyALEG4RsNbt+SYf8IfoNVd1o0vCbHv/WOXxz9SrK+jLtZ/7J2JnHjncbJGNiEwWyNXi0TFfIC7HoS9rZct1gsQmpfh3DlrpfV3cvoYnA1HByhDDgVZoy0EQPWWImMi8p7AI1V0rn9pHdyGr4Ij+0ECNUW5oKaPu7zUePTHCmLbdIknYoo///A92994POVx8BA24UtruUu3HjsKPJjMD/BL4GOJIOya9Sl353vgFNmSKywfbUaU40j9nqNy1DFFJI5PM6psllpubwkfsusX5F5cAJCfx/dolK4HYjCElGrSUIidBJYi3Pz5N46999cD7Gej/0Hysw2RIGiC/yEA/+fBZ/gr/3uaXPfNmG4vgpSmBoKnP7PAoe79rNJvfkv67l/wJuVZCqWNS1feqq4RQ55BS/cbSylgMaA/Q+PbwWW
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 organisation admin</h1>

<MethodEndpoint method={"post"} path={"/v2/onboard/organisation/admin"}></MethodEndpoint>



Creates an admin in the organisation. The dashboard uses this operation on the Manage Team page.

The new admin gets an invitation. The `pendingInvitation` field of the admin stays `true` until the admin logs in for the first time. Set `passwordlessLoginEnabled` to `true` to let the admin log in with an EUDI Wallet in place of a password.

## 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 admin to create.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The email address of the admin."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The full name of the admin."}}></SchemaItem><SchemaItem collapsible={false} name={"passwordlessLoginEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When `true`, the admin can log in with an EUDI Wallet (passwordless login)."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

The service created 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"}>admin</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 for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email","description":"Admin's email address"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full name of the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} 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={"roleId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Numeric ID of the assigned role"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the role"}}></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"}}>

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><SchemaItem collapsible={false} name={"pendingInvitation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the admin account has a pending invitation"}}></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  \"admin\": {\n    \"id\": \"string\",\n    \"email\": \"user@example.com\",\n    \"name\": \"string\",\n    \"phone\": \"string\",\n    \"imageId\": \"string\",\n    \"imageUrl\": \"string\",\n    \"externalId\": \"string\",\n    \"identityProviderId\": \"string\",\n    \"roleId\": 0,\n    \"roleName\": \"string\",\n    \"authentication\": {\n      \"password\": {\n        \"enabled\": true\n      },\n      \"oidcPasswordless\": {\n        \"enabled\": true,\n        \"linked\": true,\n        \"authenticatorCredentialExchangeId\": \"string\"\n      }\n    },\n    \"pendingInvitation\": true,\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>
      

---

# 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: eJztWXtvG7kR/yrE/pUAsh5+JKlwONSxkp6u6dmIZafAJYCoXUrieZfcklzLqqDv3hmS+9TKsn3XokAuARKbSw5nfvMeboKI6VDx1HApgmFwoRg1TBNKNBXRTD4QqRZUcE1xA5lLRcyS1Ra75Lx9M7dkWEoVkCQrGsfMEC40jxhZy0w1qIwNWVJNuNFErgQJFYuYMJzGJGJzLjju0h2SKqZh3V1R+7Jis6WUd3CriMgdW8OSlngTCakgIJWBL8CVzqgIUQZg754pPuehly6WK7LiZikz2ErCJRULRoy0IieUCy9E96v4Kib1NSLnO8iQJIM7ZwzYTGO5ZhH8DAgyx5NFeg/QXYLkBU1YQSMT/F8ZA/x2FZCzo5m652F+HaIv2CrnL1ddq6oQsVCmHDSPe2K5kIQnFKTHL7gUSoDKr7WJCihxA2xLkmlmP+Pd7XYB95EYhFdEMZBJG1AUg3tQ9VMeTXMhp/88unYELtViDOtLRiOmOqi6GYcDoM7zqzHq2t1vlUemVzcT0gulmPNFj0YJFz2actjU28D/f2frcbTtec6OgLNpN+gEMmXKsjeOwA3cYecMJQuwzTP8XkbrYLhpOM9kH7zAnFN315PgYNzB0KiMdfAuAwaN5Giaxt4Ye79ppLkJdLhkCcWfzDplcIuc/cZCUyP0a6BLJr91glShOAbUaSmU317IcvNmw03MimhRAvRRqsuUIYR17tCQd/myq6Vc2iguEOM6h7+gE3iL2+cqEGnmnMURhpwE9lAj1fp5PkTG831BzxqVuz7xBNkD1wbii6l43YLfg/v8NJlckdN+H2FjDzRJLVDnIRyaYAQaQ/hhKtg2xDyEwqj87TlgSHuCxp3Cj3NuNUCEcV4QlqRmTdy9ZLVkwoanmNF7hi4FsbAuy/W+xFBEVgy1Otjin8rBpiE69e9C0xT9mfeBVCmkA2dix/3BHpv3MDgbj/YDGvzfOuiSmppGvSjO7As1M+NCOsZVZ69TaV10ZJNEAoKNiy8a0mqmp4WxGJ4AtKA/3RYF6kLw6LAV33j/s4kdjFQ9ZsvoI08LESOu05iunWseoPgsr/spg2gCSYpGdBZjXn2SE+I1uxgfvm28AwvVWobcGqiNqyOf2pEi3uL0VaHMwVIXbT5kN0ISjw4CFLMIKNT43Uf1UYYdHaTIxVxRkDkLTabYlZL3YADqeZG/TgOKQE8EyENdop+kzVu38TEAiEv8mSrgUDJ+ggV+hl2P0vUph4VSr7VhCZIGabQ5F+FSPgGMCW4Gx8TdNQdSZDQeWZj1F1vptQA8k8AfFbsKFBFGM8gDEPeBP6wQIWu0l4ghRBKKRaUvKKs60CwEtdzSLDYvsptUQWWpIAtZOuTeEqrTrZo5VYqugazI4hg9My+l9l2jC91U6OtKCG0TGOpY7YKpS6dLGUdQn+KdU5cn9x7FPkbI2m0YQDkovs1bMW1hyT3G6vplkaKs2KssYwc2w27pafxWiCD4tuT/HTxVWobfwVSVSlAF6kbFh7m6ymaQsMnN509FA1RKWRfypfQqDFqCLg2fP8URJnl+PQDFCqDwdPGKLI3+K1fEEGGJJ+4iyj+gwX15HOG67JzraWZbL444Ngw219cpt+bRIu1VctXeJFOmBx/K62G3JWrWg1nD3pr2UlV3VS8Fdt8er4GxaArevHv3Fzagp+HZ7Hh+0u/3B/Qkejvo55j8gTVye2Gyj4NBifXwuFoZ9Pcn9YD/TVFhKsAPg0G33+3nChgGDR3Yhd3kNaexZo3M0m9mBAzGjdjZLsybeT9oRrR9OwdNrQ+DpTGpHvZ6EUvkEU15ly9Qyi6XvfvjnhQzSVXUszGgt+/+3orNdgzoDyE9yEmXoWfw9uz07enZ2zentXBRXc692wLteic3X8EUhb9BF4s2+uT2p+rRTCmpLqDcxNYRf640sNgAPd5LlKfbAlzhTcDgtoV8SxAvu9f3FDKQSDOoX6gC7zI2/1rpdxuvQ/M9jhnKFOM930Wh007tKAK8D+7vvGCwkA/r8t5OZpA5y7vsRz+MDHb1NviO9XYjaGYgrvB/s2gHmrPv2qTHcJ8SNLZmBUnaXtPAKC+6uVmD0Jvg3E5M4cdv284meM+oYuocALYrKDVdaERnxBfcAGkXxskr16+e3l68hgt8egIk4AQwuJQYflOpLU4UqQUY7fzMtjKbtekYmdWWm+ZQLJFeFsy+B8JpgAI0qjklI0hg6It7yByiAI31Audme45r97nJyLcS5Gu0NWciOdRlm+MWMNkiTaulSlHgzZz6UqnOWD4XR2fAwjysvCvc0zgr2tVpjU4+Yy9Gpqlic/4A/bwbrTseyZS8gmDk5vxGUR5bDFIastcdwrqLboPskPiDP+DDD8JxBMz9OLUVfdWoNsHM/vZRqoSCgwY/f5nsyhaGTENtKe+gok2p1jl7jpLnGXvuGhOkQNA6uC1o7YFytoV6s9UphoLP5az/w/9uiGlLK5lHKei6bfSATIR2pbM0lcr8tbSlwhxc3eWW6kZYtd8GW8WhvJvH/j6UKCtol+P/SfHY5g3GT6KQ+Vv7emZnYxfFc522GFiZXl3aEDB+bSeK7Qevqu95Rdi4eo0cGRnKWPuhNlo0E3hGexidWrV9+0HYO7ZHd7Nu+7C3JpEPS2GFvUxbazX4UKAifWTl5YCDfQDUzpQ80pbbLycX5PaCvAJbBPMef5h8JNejI/gNVt1t4+tLMnjXH5wcnZFkJMNeMvpUfcGcW3O2U1TINkxoVjUe8BvA9djWyHXVrVarLrWfuyByz5/VvU/jiw+/XH84wjPb8j2mVCeCFckwK7RXK8iP+8en3ZPuAM9iFE6oqPDjXnXaB4Q7A9Qilf75dPzn0/H3+XTsc4dhD6aXxthTbb0fb3xx82twf+wekoAu5p9KgQO1wBILIdi02cyoxrZwu8VlkE/ZygtclyruBp1Yh+WlAFZEd1gxBBfOC48myApuhwRvC4hGcYsFjDuBOTQ1j+6t1mpXl9eYh2f+3TuxhWyg6Arbevh3GHyFv3a+YF3KFs+4vglicIUMh2PDwNHFHEd9ti8rnTtb6fgfULL8k1hXuGwWPU4Y/BdFaz3yA+oZVPdjsd192XugKBPcbtQnjnH+A/uKX/I=
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 use the new sandbox organisation in a later request, send its `id` in the `X-SandboxOrgId` header, or bind an API key to it with `PUT /config/admin/apikey/{apiKeyId}/sandbox-org`.

## 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 service could not deploy the wallet.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 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: eJztW+t320QW/1fm+BNw/EzaUrKlZ0NSwNCSHpLSXSCnHktje4ik0WpGcUyO//e9986MNLLlOi2wHxYvZ8GS5nHfj99M7juxyAsRcSPizsmMJ1p04ZWOCpkbqbLOSedqITUTWZwrmRkWFQLGasbZUkwXSt302dVC+AemYaBmBt6IW5EZ/MkNW6mS6XKKq04FM6oL/2c8Y+LOiCLjCRtfMb3SRqR2tZyvEsVj9ubHlywttWHa8MKwpTQLNlkYk58MBhOmCvug8akL68VMGjsedikz+Z9SsBmMQnJUMeeZ1ByZ6rPLgBhgJZWZTMuUqRkbWcKZWeWi/2v2a4b0aFHcykg47gSPFm4U18jGt1dXr9nri8srXM006bcMTVW8YguVwOzHbCYF/Dhhk1gk8lYUq/E5kD9xIrQPRqYCmE5zegBaJsTfJOaGT+ya7jWt5tYeIQdIQCXsOGBHWxnhd7tOY26lM6amv4nI9NnXIDrg7mJ8/uinM/ut62faOZNQquOYlMAUGQ4odaJhu6m6uyjm7pvdHEwohrUkDHHKAQsE0RpahoE1qiLelr2cZ072Xm7WIIiff/XG3xQ8M71LGMZNWYBkFoLHorDCuuUJGAMY8sR8+awS7vMurPrls4W4ew70LReigKXsI47FlRO1FEXEtYDl7mC9SKZA97evTs96l9+eHj1+giKfBEv2n/2mVdZzJgALVURqAZwbdiNWlibPGU+WfKUdgzjwu8uLH7wNgdgSrZC2zApPZcYrlPjheZ7IiEQ3uOstl8semHzaK4tEZJGKRQzmMs6sHyIfXfIqYAS+Wdm5nSboK6mziamAB0GOGy1EdGMZ8LLdUk7KbwSaX6UZbsCZc0PuV/sL8V0Q3Rn4XWlUCoRHoHJTrKpFwRhylYHEQaCm1IwoJcOGeSoXhbUTZP5oOATFZcrgz5FzjGp+bdi16JnMWJQIDoYH0Qf27HQ71ZpjiIEdkPBMzs8ozr21PgljCgHRRJuvwJE7J/cdpwb8GSoAVY/vNAgt5fgrL3B1I4XGJ+fjNC1JLmadk1/uaWlZYPz9peN08aZIYE+3yRWoGp5qn35BoRVfEVvfi1XnuttBiwDyrffCRyNNgi8sJxfFmzxucLQZ5esgbiVQOjlDTLNBn7xVsZLWaZowGAaYCyhEoqNjWCCPb0YAG8HqyMbkzGYGYQMDBP8xGDaZ0mbIZrNCpdZc7evffczxbg4cNWUdiBKenHS0KWQ2b+Ueo/gl8kjhHJ2EfAbCkQCbtiR5Cbm1w9jywDxFQnhIjgIaIeCkOenQT3dv+pFKB0iIHsg5hr3OumktD2K4EUpc4thiEJPAA2JMdytwoX9iUEeH4xA6snkiwgiT8RSyUxV8iN+sTNEJtjyq29lLQed63eIitRy23KLFnbZFFCRPaw2hjLxldJHFYzYvVJnrPjttlhNOsMeMFwWGedI9Rqb31B0N3yrErNSCCo16iKWG4ihJmFKVhJVhKQllFxHTXCdWwg4vRKpu4bm0InUGrLc9KMIomplXPONzkcKvt3X4cmIlprZEd2YnQlrwM0NJElm6qhBVFJWFTXDAosxieSvjEpLsnNwO7M9LwNHTxXdc32iMRpBxhIGkFqtlRmYH32yEQpnIgmG9gqxJSEh6v2NcblROgVnSSi76geKggMGiudt4H/EsEklC7x25fYj0UESEb2Jw8q2XmA7fibtcFiu/qGVuezPPbMsXOyMkozmj/nK9Bo+J5VwanrwFcsSD1XtuJ7ElzWqq9gWl/7BmZKQ7St5klf9wYTwXmYz7n02c+YF/2HpEZcnKvyMrr2rQMSr3Aubh02swFSPmLkllQsTa1cWOJ0tdsMFUJCqb+xodPFAU7Hx8fqbSFCpQZVSkkqoI8fTVxSqu5Ex2plB7tIzUuoR1tLQ1SkCruIsWPJs7b/brLWjfvcvaYbRsc35YKvc/698eb85GCioReRqg2XAFzDucjanZP7so5tNzuP47Ht3gB8g2ok7AoGAJIdwS122ZBbvH4FoPXjDkleqxP+6q28pTs5koiHlb8LV+9rJoHVL/fEdK3zuKmN0/KBK52T/OOnb7MCQH3RoGZXLHGKNuRLZF+LY1Bls6PT5w9Aa3e8ZuMt0w69BUwcL3jPJK2z1y2wQfONZJAEfbaAmh9BUvboTJEx6JB8dLmAa5sJr3sGRogtztUZcquSEAg9QwSCVRojQ0ZYzPC2GTrWuh/7SsF9Dex+d39a7vql3f2V1RUjazaD7FPFNvPlUKOq9sa/e3yO7EFKVwdaSvsIKShXTsBOe6TInSu3BoQ5+dixkvE0NVwYSQLCoqY/vagVvrsGnaL5a6bYQkFlMrpNK8NGI36hBCA7Y1qZtg3x77PpWYKmyClIaWr5ptKAcW6C6RNCtfRFZV+bkiscBEsAPbf8AQnYOCNCXQk4b5WH+jPaYlFbGZw7KgDa+6+qqTQiHdyPxSJz9RrLd198coEgkABis9Uu5Y0aerl5cswlpzZovQJosWOvtQ5a7X1x/R1wLD626jC/dt+lZXbS37YRv0O+GiKBSYm/MC+h4jCk2tf3Opmt03tjGUFDAp2XpgzzbUzd4Ym3Lt20gos1xk7DPSR9Biwzer427DPIrSAU8BuBKgTXfG7257tjYaur4hgYJgzmWmXatkK0SaDp9bqccqAW0jnJfCz8bkTQD3peC31gmdj6nSeDlsLLAFVoHSYx1Kw5acSy+syvPQLKmX51A7QnlakCNpNEJIpoF4W2Zk7PT1GCNHU9Q1utEqi6omcpMtqO3AlYBiCCAK1eb26eHQCLh1zXargqbS4a842BXBrURY+OL1mys2uD0aWJse8Bia1QHPJcwe3MN/IYCO4/XArdCDFSYM9Qf0kcQhOEJWsSpAmMbhqfVxA1lTheuFYG2V9cD6ZEZ9gHIxDEJYl2IYLt8Al5aweQNRmipgwy6raxtoY5hacnEH7XPXQzO+U4DVim1z9fgNMJOoFZQT7DRjZXaTQZcVOC3B4U0fbldOo5v3i9rSurkCjbPUWaFA/sfKlWD7BpVgCwjKWi/GpxmXiVUt4VuPhkOqDzDuWCHBE2oEnpuibYQxd0JU45vNBLoOQasnT59+IUb8UfR4ejQ7Hg6HI34cfz4adjBKe5CWipOj4fCvBFUlFZqOlw9DWKsqJqwb2tMjQksO2nwfHLsLgD3dkaZaw1/b8YE9m6L22yJsFWROJHSxGUQPaoKy26iPjPcXRjvzkz8U7DQNgY9mR9Fx/Eg8nj3hn0+fRl/EQzFCc7Fq+fgNt90IfFA3acF6JjToj9+tzXmb2vAHoCB3pwXMLZiaqxPTFi/261rfT+mo5HQLaLRrBYerDuzDqKMj0CGx+iG498NQ7r8Wij57AAx9AIcP4PABHD6Awwdw+AAOH8DhAzh8AIcP4HBVsmaqiQuvbMX/UTBvVcd54dr8pLCHjsqEvw/59WDSrA3sbekP3J208D4SPtkWrubS9sldphUlIihUiYTqlhPXhHmE3/CK2Z+M4jaKxA+DcZGSujXe35NcnTEcvsvQ49AKqLye/Bv+13v1qnd+frVYnKTpidY/2+ts3Oyoc23qCxVB2I6/3dRoeY6GR096w6e94RdXo+HJaHQyOvq5sw9sblgSmIUjviYHs5owtuOy96b89SZ/V4qeg/tS9uLoH4OrL74H1hwqBrrAAY8+EH0JtxZFoYoz6LFQYPj7PNitBQVp9hD17NoqqHAjNKpSABC4blm+xZJqnX2FN5CyvDSsgtxRHNsCwYEVYN7QTeWotDNiixioM7APVWEs8DWFvAm7d3HAhunX5vaQC8y0gTef+tYooqThmgRU6m6FdYZXmatQiIKhVkjONnpDQiI2b5GSU/NEUlrYtI7R39g63mSI7atC/k4FSVM0j//WjjPO3OV95zC0zYaMbB4uC2lWhMqe0rkB/Lxed+87X9GhyikImN4g13yOB2MVSAqvgIKFwnu5udIkCI7DO8HRxLJCVC0lbUdr5yJVjlAYVyI2ViFZMXzr8Vz2LYDVl6qD1DUXeF2ouIyondyxzL4VLoE5EPau6dp+3iTkupbgJRqS1b+XY11b2hc7AP1TZ8MeqN5Anv1ZU32KVcGa1dky5aLGOlXB409DoDqeyTvIzzbMWRrZhH0C0cWWTabgMiEZ4En1p10m+vP+xrInzE18hmcvKA483Xo+oTIitJj7jj2U+5rSPPDx3durbd6CAzswaK09eXYlRzMWEQ0iWCVB8l6qlmhCp/JM1BtlYvTzH+vb4S+8JzUOJkJQdj+EuoGgtmGebWjmbkhuFz51vQvk2dMlX+9udz6qKQg7An/EVNfvdZhqLWjd2T/a/kz5gMwjCsgQeWVCgG6eq8L8s/asyjnkN/WrpkuG3rxhV9UkrLtvZUw9F94NwUacSfxv6jtF7z4WeaGzAMsAMszOKgFrNna9OvvE4USfUh3YPvF1+Eczn1SwzqcVXEXtIyR39G+R4RzNwsvz1NdQ098lmMXCNa62d2YR/LGOhl6IfNdgDVTEukf8SpADmyVqqa1jOUkTtW+Pz9hPZ+wT8Exw9vGLq6/Z5XkPnuCt3W18ecFGT4ej495jlp6raJCevwz/QMjW8AQ/gwcIsG/Uqg9rEEVArkf94Zbqlstln9PnPrA8cHP14OX47MUPly96OGdd4/21OlFYsYrKSnuwNOYUq3boBB71j/t0coX5CMrBgB77lxZs2X7CFxQKh7+pO/xN3eFv6g5/U7f4//2bOlcl4YsBlAFQlq5djL53JfwvndsjW+lAEQ8/AhRjgaU+DLi/n4J0oWhar/E1xJ6CmgcIybygLGhbCV/wUt2/WUjsDMKH63aH63aH63aH63b/w+t2rVHxhnqcrUt3lF7hA0EJdoy7KtNz99X8iK32sJ5xSmp879gQY8GCCwZP3V85p4QwdQq+xEuA8O+Tzq/wD52OUQdBqBa+v+8kPJuX0HfCGLsudmTcdeo1SnFDKIX7gfHaf8pWAZWbgIVlBv+NrLVOeYY+DF7yvBpuv+ycULX4djTqAk+n/guT1u9x
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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: eJztWNtu2zgQ/RVCTwlgy86lu92gKDaN0613gyZAnGaBNkBoibbZyKSWpOK4hv99z5CSLfmCfduXJg+xLpzhzJkzF2oRpcImRuZOahWdRT2RCScs41nGZvgnHFPayZFMOK2wbKQNcxPBtBlzJa1/GrPBRBjBpMViNpKZE4ZxldJdotVImqlfx3Ju+BT6TczuVCafhFeV+j2ZzoUJy2gPrURj5xaWQv960ZMQufXyiRGpUE7yjO658w+bVhsxgklOe0srx4IG2GiEzbFKsKFO53HUila79FNg4l0YB2TOs6wnx9Lx7N4ruc4FFn2ubQbxlZs2Ovu62ED42l/wjCCQ/xRAzRs/kjBQj7ztFtgN9UsDYxjPCpgY8JfkEoSti9n9RCg21wWzApD7dxPBU2FaQZkwzzIRzBQqwLWGUKqAn1ZOvLhqdwXb0502tAK80rYYH3OpbIC6hNOL4/VO6wMbXENuisuG8CarrgR/DhQJDjFduAqHDQXxN/VNDeruQsLW0QCjsjmbVWDxAhqAO4IGD6SbMM6GghtibpIIC1n9JFQN3h0Sip3f9MGjeRNqx5+E3R/JkdFT/7YU9uDIsdJGNCwGWTWFrdynTUsTSkx4zfcEaCg9B4TXC6j2GuEdeLy5G7DO83EnULzD06lUHZ4jM+edBX7/EvN+uuyUGtrQ8MgofrDPI/74d/u2GIYQ9NNHqgAho3MjCKfUsylEt+5XDSxin1QFua499DkY5uAJYk3qw9bXZkz6Z9icydGa7kMNN4Jau+bALoenBWgnXqSFbn89FJlWY9oV2sw2XctF5Eym5yKN2blihXpSeqZqSdui8DRzeHdwquTxeVApbfmtmhr8umBdAIWlcoT6hQUbVoILU15WUc+MEZdZCO2nweCGnXa7VM4k1Z0AEu4oIrhvQovnVFAkSml0NkIlFa3IJhMx5dHZInLznESsM1KNo2UrEi98mmf07Je3b38TR/w0eTM8Hp10u90jfpL+etSNlg+kMhRWS0qOu6f006yGtXIc2kDqvWpUb3KhDDEULLE9/CJVvnApR5c8z7Nyfee7JdWLmv1r175GwhhtLnQqoNVf92oGwebSVz38LhJHxdxQwXQyOLGWXsMiYcXYQ7uCBQYud6jfgrKO5AeOKqBy0H7VP6Il/bV2YNbgAThV8rLFyvZcYppwFdjmO+xWX9yF7NFPjOydoiKvjfwh0i1o3vzUpOtjP4OxxddtFCm/zQZGELIiKYx0cz/4nPsGgsuHZWsRffDd9RwA+yfkNR/ThBSVExULIxU78ENV7/TLxSE2+KQzqltYDusmmgayQGc/aJGyqNbB0qCqHfjfAYpKpp0G6SOyknzYNZ31xFSXLmJdYTKqnM7l9qzTSfGujaYYy7HhysVSR+RXU8GN0WmR+LTco+a/NNwCFoRpn7gNrzcNeVhjf0sUDMypIrCiQOjp+3rCecn+apBtGrYaV9aDUDX8s2eeFaKa4h4beh6rAaxqqJgNRvIFlT7MIMFG9sgOEKZQpJxBH/MY5DwRhy0m4nG8ofaMlYLvqH0THDQgvX+MqT/VubaIwlz3UdMxBH78eT/Y9q028yEVrK3MC5pKm2nyahjBVgj6vCcMw2bRKqcpbhGlhlQjXRUQnvgCgkohKba2yHNt3O/reK5CIv9YP2oSoc6hDW9WQrBbP2O0wIEOgxblPBCW9DtFBIMLZdBC0vnzxRdhkC58mAl2UTtb9a0tuMLIdnDts7N/6IeX3YI36P2rLVYZfXNIFjmd6MwScdC5iFVCkYwtu9qP8tCG0UdiS9FiE9SAMCk90w5zVqZ54+hXWM8Yh2XcpLbt/ZXAgY0yPbMhnCXS3tr7kwv25YIdgA+gWP9y8JHd9tq4w9OwW//2mh297R6dtN+waU8nnWnvqrYnaQGlfBtFIxCYdCiqVTKBu8D1OO5uhW42m8Xcv47hcqeUtZ2r/sXl59vLNskgqE66rMEBD1aqk2IVPaimShbCftw9Po1P4iOSzbV1U65q9oQD7PZ4tZkLtRb3+jnAfw4oM5kOyZ08w6GTAPYRXZQt6Gv0fIyFoQkRoI02FL4ooBFRWjegR9WeIFCkYLEYcivuTLZc0mMc7o1vnQgwNz6nQiOtirbvXUAcL9Yj+95Avn51eP3q8PrV4fWrw//41WFn1XyiaXT724MfH/HCj8NhzbkPSu3d1mlrWT8T9C6vLgeXWM7LoW898D75gbe8oLJZvVLzmvrN2TdYQf/Jpp0i7yiVQNb3q+XhzV6B1bQYVhMkDzg2/QtEF1Kc
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.

## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><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 API key
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-api-key

---
id: config-delete-digital-wallet-open-id-api-key
title: "Delete API key"
description: "Deletes an API key. The service marks the key as deleted and stops accepting it. The key no longer shows in the list of API keys."
sidebar_label: "Delete API key"
hide_title: true
hide_table_of_contents: true
api: eJztWW1z2zYS/isYfrJnZImS7TR2O506ltOTL409tZK0ST0jiIQk1CTBAKBlVaP/frsLvkqUnbnrt15mMiYJYN/32V1o7YXCBFqmVqrEO/eGIhJWGMYTdnE7Yg9i1WXjhWBG6EcZCBZz/WCYhS+wxLhhIR0I4UDIjFUpHA0CAeSSOZPWHcatiWKRSuZCM7NQS8NkQlQiaSxTs4KZ6f6R/JHgGaseRAIUjIhmQJivDHvkkQzx4EzpmGWJlRFuYOIplXrVYdPMEs1CVi1mmQFdpO0wo5h4FHrFgkiKBPdxy/JVFmcgRKwekSsoooCIJtW9jqdSoTkaZxSCeQKVzOTcGWko59Ly6BOP4O0mFbDjIpX/Fis4lXLNY9ijjXf+Zb1l4w+J/JoJNhqi4mBoNf1TBBZOSVxNuV3AcwLn4Y0TReDd8bT4mkktQAyrM9HxTLAQMffO155dpbjXWA1W9zabe9xsUpWAfrg+8H3805Si7tXCiWi93BPkUC1sppOGv8FcS/jDnaljFaM1QQ98c2TQamAnCwvIladpJAMyYe9Pg6zXu6KXJqiU/JLr7oE2qUY3WOnUyb+3alRIT/61uyqicNs8rbQRfnDee6u0c+aWNDIsvIKmB3kMPPDC4S4GR8kQApVIxgKCNk7LpXHtCwkARtKCg0hvWlQEZjt+7bSHkQzB0HImIWRzNxSJS7yBIyn36vXrM9HnJ8HpdDA79n2/z4/D7wa+tyli7SV+72HXNosGNoQK0gmyh4F3gwfYJylnQUZIWMhXFDcRxjQFu9UqzALkwaQxGU8CijWUKzdzJRnXmq92BLujbTuiXfFgwYgEg/8QxZzNtcpS3CiSMFUysaapQYEYPFkxhwJO/qW0C/av8fiWnfg+ii+tiE2byUSSxRgtDigwQrJQYpDlLBBRkqniOvTuNzUz1E4UO3G9CvXnfUNKyHkCOXx9d/OefRJTNkYE7bI70BWzFpJ2cpHZhdLyL8rGc+YCnv3guPw4ccZwyLtQUegS33mhQ89Kz3kiDZ3f/cJ4GEt4sYCY4HFAkA5bLkRS4gcExFRlIA/iLDOwYaqeWoi2rTSjRqyuF9OfA3kjr0cf/hr138uRGSW/ngaXo1ejh/S3j5fXZ13YNP59cLb8/Nsv8iYyEp6zz3GUjCK/2+16m620rawMkSGgVO2Y+Z2cCUztrVjDmhQChQ4LQDsE0plWcR0g60iUpz0oxyIOhSdLQ16A705OUTge+0Te2XKlMlgFG078CdLgLBFzsBBULwrWLkk941kE8Hvs14x27G/qyNQSVFhYORzzUKIj3Lpjgl+cQqVbC0FJlaVWVtQt00HTfBhfNpUywpo6PEDkOKNQ0YE3V6qdYZBEEEEWQUNRFRlW1uVmXAz8wasj//WRfzbu++f9U1D6c+Xo8d+sfOF/oo45kmvbItIZSNUUyfF/MbNXaTvqus6psEJZqlUSraiTokN4eCLnmkOJUJPvkYoBK2tRRJtxlRKDKncBYR05p0TLkouD7hziCrIIcjLt+1jFKq3LVcRxl843ej76hro22ilobXBQVfgyCStwcRYCElGIn/nUNNyGu6cC21GDSER5ysF1S2rlCq77wae9lvapllZFvaW72QVtyG8NgqkSFRrJg+nQbLNoGwrUSKgHIdI8owDmIzVn0HxyiGPebetioPeSEbrN/nedx66HnlPDieoyXdJkIeLUrpgjTr0BJ5cUZykCawPIy7Z/Jcj2Tq8Xxb/CbVCrQkhZ800aNCSgIvdT/t4NVIysuf3fIKXm2udQZBvY3L/avnp3jK7c3/eVI8a+Bqzqv8rm5L7qSP6WCrxdgLFc1QpUQ+nB+Yl/7p9+bumo92Bs2enXkKqRnvsNhAFVxlOLx53Dn3FKx1sIHtL8t8a3E7+PHL95LqrnrNBa6UsVYvDQ87AWQfe780wzoavTbf1NGTjQ2G5ayLe1uGVMvuE4jqcwdpfzbqH99qjC885TIP5sm+b4H2waxMYA645mC47jEwMBY0hEzEfERkL1qtthN1jg8dZgf+MdwHLMEz4X1b3KjtlP3aXAP9TsI+CnEx5RCQXbE5tmUeWRUbUbEPACoI3NzG77B+A9KS5qJtUYLJ7AIx3s0ekEzGBY/iJAoHBVv4+o+wW7JRFkWtoV3Ry9EdCsaZzb4PUeb3YsnxMk59dPzN0/sQO6tBiefLw8BJIoWX53AkZYKAQ6x5Eup5Ca13sc9Byu9yh8eqACaNNbF6ps8mG0/RZrKGKVWw/2ZRqBcmFtas57vRDWjoBM1yFvl9rAbQK1urOHzEsU7sAW2ELsOW7c8rYg95WJ7zC6XVBebE/a5dUO3co5H1VFszFJ7xT18g4NdmGrFNR6tnzkcV1HcyKfMMfGXUhOBUu1mMmnoiWa5PP6hB0kxZwFGS8jskHKA3HYYaI77+4d9KHN12iOowca97FxqQfY2pvS29uibbn+NN7VLQiwbXK3BCk3phDPUcplxh6mIQQrLUiQgjZ0zKoyjX7zMANkMlMFNvGAsKkoxSZLU6XtT5U/S5fIn6tPzUCox9CWNuUhkFs9yhAvf2CKRzgBC0v8i/2ZUyF3mss0AuePQkMfzKeRYJeAjehrgA02KvqogxtKydEhtfLtB2+hDS1ZlGl8e4gSWRWoiC6pADowqkSCZ0yO/s60NMRg6wazMl7buLnhETkAzuQwEdTEywxFjIVtXIfmiPSVYAc2i/BuntyZW5qk/XR8yT5esgOIBwix0dX4LbsbHsEbfHXcRnc3rP/a7x8fnbJ4qIJePHxX48lcJ0xlCGqMSAyBf5FMELtg10HX33Hdcrnsclrugsq9/KzpvRtdXr2/uzrCM5vqCrdyJxorVEFWeg9II5I5t0PjdtI97vbxbKqMhWpZk8fd7xfwvp0BtZr5/59Ltn8uyVPZiifbSyMYqtHC5NJ1Xne+eI8D9wtBfkGKtcddpTtjn5e/eQBSL8A5eGa9nnIjPuhos8HPXzMQDisiOJVryiNXoqAhgmcodzMIdPGM5w5+zfuZQ7b395hWZYrykKCsBObwBo8PNBWVsm/uyxmAJHPLF+Ts2sGdnmtTL9nDq3dX4yu6RXb4nDMvkTN/QAatcv2QgzLdBf9YSknRgiJuNv8B74qQDQ==
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 API key</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/admin/apikey/{apiKeyId}"}></MethodEndpoint>



Deletes an API key. The service marks the key as deleted and stops accepting it. The key no longer shows in the list of API keys.

The token itself stays valid in form until its expiry, but the service refuses it, so every client that uses it must move to another 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 ID of an object","in":"path","name":"apiKeyId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service deleted the API key and returns the key as it was at the moment of 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apiKey</strong><span className={"openapi-schema__name"}> object</span><span 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 API key that the service deleted.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the API key.","example":"6889e1a4c5b2f30001a3d720"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the API key. The service does not check this value for uniqueness.","example":"Production issuance key"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`config`, `audit`, `service`, `onboard`]"} schema={{"type":"array","description":"Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400.","items":{"type":"string","enum":["config","audit","service","onboard"]},"example":["config","service"]}}></SchemaItem><SchemaItem collapsible={false} name={"apiKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed JSON Web Token. Send it as `Authorization: ApiKey <apiKey>`. The token holds the scopes, the organisation, the organisation administrator and, when the key is bound to a sandbox organisation, the sandbox organisation.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0..."}}></SchemaItem><SchemaItem collapsible={false} name={"expiryInDays"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Lifetime of the API key in days, counted from the moment the service created or last updated the key. The service uses 30 days when you send `0` or a negative value.","default":30,"example":30}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the service last wrote the API key, in UTC. The service sets this value on create and on every update, including the delete operation.","example":"2026-08-09T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"expiryTimestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the API key expires, in UTC.","example":"2026-09-08T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`igrantio`, `aip10`]"} schema={{"type":"string","description":"Type of the API key. The list operation returns only keys of type `igrantio`; these are the keys that you create with this group of operations.","enum":["igrantio","aip10"],"example":"igrantio"}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the sandbox organisation that the API key is bound to. The field is absent when the key belongs to the main wallet of the organisation.","example":"6889e1a4c5b2f30001a3d710"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span><span 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 user who created the API key, and the moment of creation. The service keeps this as log metadata.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the user who created the API key. The value is an empty string for a key created with an API key.","example":"6889e1a4c5b2f30001a3d6e0"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of the user who created the API key.","example":"admin@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"at"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment of creation, in UTC.","example":"2026-08-09T10:15:30Z"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"apiKey\": {\n    \"id\": \"6889e1a4c5b2f30001a3d720\",\n    \"name\": \"Production issuance key\",\n    \"scopes\": [\n      \"config\",\n      \"service\"\n    ],\n    \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n    \"expiryInDays\": 30,\n    \"timestamp\": \"2026-08-09T10:15:30Z\",\n    \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n    \"type\": \"igrantio\",\n    \"sandboxOrgId\": \"6889e1a4c5b2f30001a3d710\",\n    \"createdBy\": {\n      \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n      \"email\": \"admin@example.com\",\n      \"at\": \"2026-08-09T10:15:30Z\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"apiKey\": {\n    \"id\": \"6889e1a4c5b2f30001a3d720\",\n    \"name\": \"Production issuance key\",\n    \"scopes\": [\n      \"config\"\n    ],\n    \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n    \"expiryInDays\": 30,\n    \"timestamp\": \"2026-08-09T12:40:05Z\",\n    \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n    \"type\": \"igrantio\",\n    \"createdBy\": {\n      \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n      \"email\": \"admin@example.com\",\n      \"at\": \"2026-08-09T10:15:30Z\"\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 caller has no permission for this operation. Only an organisation administrator can manage API keys.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 service also returns this status when the API key of `apiKeyId` does not exist, or when it is already 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></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: eJztWFtv4zYW/iuEnhLAlp3LbKfZYrBpnO66nTbBJjNTYDqAaYm2OZFJDUnZcQ3/936HlGTZlqdYYNGX5iWRpXP9zpVcR6mwiZG5k1pFV9FAZMIJyzhLjEiFcpJnLBUTqSRRMK5SZsRcL0AjnW1SJVpN5LQwnAgtmxg9Z24m2N1wcPn+ZshutqRDawth2M/C8ZQ7HrNH0MnwkmdWQ2MwQyyEWTWVEBFXiWAzaZ3GNyMSbVKmJ9AlbbvVcUO3BR133rBaoRE8XbEpXwjmNFyf6SzFB+v4ii14JtN/Qs1CPwlim7OJNNYxOWErXbB5geeldLPU8KX/Hv+mok6kcxGQGKaANWATwB3IqXQ8+8Az/LrLBSi25g1qoyEj54bPwWFsdPVxvRepd0p+KeCEZ5xI2OsxEEcC5722uUiI1u4TTrSZc9dhbpWLjg9yknE5t8DAFIkrjCCSOpRVFGIYKcmYnLsZnhXMJW9b3AEMnciIL4XEx+gKYkUnsgnw4tHVOiLF4IQ6qabRZtPZd/fOP/AsZkcdt7B7rJ+ZNlOupOXBb80KG6z3CUImCOti9mEmlI+gFXDXf5shD4TpBGHCLCTyzBQqoFUHlEkV4NPKiWdXaSff01YbOgF8aYHslEtlQ/otfQIEdopNm/UUCaXdDt8cjzvMYocnZm+Fz2S8Dw4xXbgKhz0ByNXf1GPTXXDYJhpMq2zFlhVYvIAE4J5wJ3zao1zGghuqoyQRFryoE9WAt4VDsev7IXsSq12oHX8qM7MVi7qhlMweHDlV2ogdi9FNNIWt1NMl0gTeUtz4kQCNpc8B4eUCqqNGeAdG9+8eWW9x3gtl3ePpXKoezyW4e2v8/0mshummV0roQsKIUfxgn0d89Gv3oRiHEAxTfAtupyJHOwNOqc+muqnVfjXAouyTqiDXtYc+R4ahgseINYkPqu/MlOQvobxqWD7dxxpuBLF2mwNtDvv+Jp7RbTvheSwyraakFdLMYbqWRORMplcijdm1YoV6UnqpGkVLXWavhtuDUxWPr4NKaOhRuxI8XbAugMJSOZkIA4I9K5ELcx66eciMCZdZCO1/Hh/v2WW/X3e2ANK2t+1Cu9PTJpguX2tqnUg883me0bt/vH79rTjjl8mr8fnkot/vn/GL9JuzfrT5RCJtjhEqLAk571/Sv91u2JiXYVSmx1t/yJtKJkKPWQc4xTx3K3KzTAMoQduN4Dup881NOXrkeZ5R9UJU77Ml9euGj1v3P0bCGG1udCog1T8PGkbDrxIPPf4sEkfzzVBTdTI4uuXeQidhxdTDX0MHAzct4g/gbqL9PUenUDlKox6pmDEb8vcQ151cAVBl7naQgEdmK0Yn8LBs1D74Rh3mp08dsoSrkMwUua8EriU4Z3/j4LxTNEu0kb+L9ACaV3/rvB1Cn8F25McDMsyr2cMITFYkhZFu5dfJaz+n8PiJtq3v/RC/BsD+DXnNp7R3RuW+ysLCyk78ykp74CkUhE2eQIJ1M027bkhrv76SsKgxKNMgqhsmXw8oKpn2bPp56XrbEuhuS6C3bi+pTUTOkKttq/EAB5QSCdAVJqM+7lxur3q9FN+6GNGxnBquXCx1dLhs3hudYu2l2j4i5s8kPAA9RPMYuw2f9w35tA3RA2VqSLAqUHWmhA3j2IS6LouEl6eIXcPq5Wm7ltUzAmedQlQ75WhHzqhaB6vxjk1lIp8xd8JGFGxkI3aCzhZ6mjOYqh6DnCfitMNEPI33xF6xkvE7WiYIDlrX3oximpbNlFxHYcv8wR9U4MePHx4PfWtsoKgYayvzgqTSZtoDd4xgNYK+PRCGQVlUlz7FjU4lQHyiqz7DE99n0FAkxdYWea6N+9c2nnVI5L+3r3YToZlDe97UTLBbL7Do+FO5ptYAhCX9nyOCwYUyaKE2/WnnvTDYi/g4Ezun32F1gD4pD3OnfpVqZ7zH1lCrqAv//pQscjrRmaXEwYykrBKKeGw5P38vrwGwiPmp1/Gn6rC3LUjDipXdoDH8MGytzxgHMm5S2/X+SuDAJple2hDOEmlv7YeLG/b+hp0gH5Biw9vHH9jDoItfeBu0DR/u2Nnr/tlF9xWbD3TSmw/eHp59LU1bzAuBHYmiWhUTche4nsf9g9Atl8uY+88xXO6VvLb3dnhz+8vDbZd4EFQnXbaTAx6sVCdFHT2Ipk4Wwn7eP7+ML+Iz4s21dXOuGvaEK4T2fWG/HhrT8OVe5/91r1M2BDr59/IMJ2mKk0+MdTnwPkaLcxAG2CgmO0MvXA1h7FG7ocFHpG2jD++vjlykYEzMkBmkar0ecyvemWyzoddf4Lgf6cgobnwRh/mIfRbP20PK0UQ5+W+5GJ0ev2j5i2+YWiGvRqGiOegHF37h8Ykm5bEbqA1WnWpe/m+wvFw/vVw/vVw/vVw//YXXT61tL7S3g0uougHSSSTQXPugNL4dnIc3zVPb4Pbt7eMtyHm5b2/PGk/+rFE+UNts7b37x45gBf0lm1pZvqNSQrK+qcnDl6MM9aIeqAmSTzjY/gFSFX8v
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWFtv2zYU/iuEnhJAlpxLty4oiqVxunoLlmBxmgFtANMSZbORSJWk4niG//vOIXW15Q572F6al0SWeA7P+b5zI9dezHSkeG64FN6ZN2IpM0wTSiLFYiYMpylhz9GCijkjikVSxSRRMiNmwQjXuqAiYmTBtZFqFZBJ+ZYpklH1qO2yUoxqElv18ChiIiRJJWhV8N0USmjCDeGiVzFJ4X9Hu2FpqrtrZzR6ZKC41IE/50oWIvaJlqUhOpdCMxJL8FFIQ/RCLqtPRWqITOAXhfeG5YHnezJniiI24xjQiaRI+NxhNOJzbmh6T1P4dZ0zWHFRQ/bBmQ0KcqpoBsuV9s4+rbfQvhP8awEeWKmEg1t2f/Yt8I0Cv7iYA0Ua/qWMXI9Hpx8vxm2hGpOUJyxaRSlDZzjumVOzgGcBVqFHtcxluQ846nuKfS04fPLOjCqY7+lowTLqna09s8pRThsFm3ubjb/t07V9oGlA9nqngf6ZfCZSzang2uJLjCQFMJNI4BZYJ2gCQ9LvF0yQlSyIRnLttwWjMVO+U8bUEwdPVSFcPNSUVYEArBn2bKrd0fO41wbfcc+1T+iccqGNFVhaipvQ6LPeBbTpyGXw2BFmHZmAXDH6xOx75xCRhalw2FIQfBafxaTtLkjoNhpEinRFlhVYtAANgHtEDXjAzQLiZcaogoU0ipgGWQnZ0oK3R0KQ85sxeWSrLtSGPjK9n8m6PJTCFhw+F1KxjsWQzxJpK/cZ4NIIvEXe6B6CZtzGALN6jdxvhHVgenM3IeHTcegSN6RxxkVIcw7S4Rr+/8ZW43gTlhoGoGFKkD+wzyI+/XNwW8wcBeMYvjm3Y5ZDNlKsZBhNjt22Xy2wMPq4KNB1aaHPIcIMeAJco3q39bWao/4lxzKYNOE+k+CGU6ubGOhzOCsg7NgzFB7fPc8YllfcFbSp3XAtF6EzqVyxOCDnghTiUcilaCWtj/R0c7ifnCp5bB5USn27VVeDXeesc6CQmCcJU7Bgy0qIhQxizWUx/kooTx21HyaTG3I6HNZ1zYHUVLYutJ2altBUf6uo+R57plme4rsfXr/+iR3R0+jV7Dg5GQ6HR/Qk/vFo6G0eUKXrJxqVHA+H+K9bDVsdq+p9367vLnjqRjWT8QoxZVluVuhrGQuwE9Re79TtaSucMPhI8zzFFIbtwy8abVi3HG0w+OQxpaS6kDEDrfZ51LIcnCtBkbMvLDLYyRRWVsOdt410gx8HK+aWgxo/MHDTo34H8zbk7yj28Bzyo26e0Gg26O8uuJ2AAaDKAPZxvCg7ZkYNAKDJtK/ZTX1iO05NU0SFC2BkqzW+9IF/9B2DfyewYUjF/2LxDjSvvuu4HMN+CkYg2wMgpOw2WxiBkGZRobhZ2cHw3DYjeHzAkeqd7dTnALB9g17TOU6QXjl2Ejd3kgM7eeL8dwgbjG0II0hg3ULiyOri2A6iqMxrdcPYqRq49hYCioLHoY6/LE3YpEpYjuDhui99Nh76gV72zbcjlskSBFhXqBTrtDG5PgvDGL4NoAUHfK6oMAGX3u4weaNkXEQ2t/eo+ScNtwAcTst7xLX7vG3IQ8POLQapi62KozpI3ASxrwOdl/lhg97bDpJ6OGrGLjsUYlF7omnBqplx2tEzrca9qn3DJJLwZ+grbuJxNpIpOYAq5uoXnBh4ajHIacQOfcKCebCl9oyUgm9wWEA4cBx7Ow2wG7ajce25KfK9VFBXwY9f7ye7vrUmTEgWrSvznKbSZpzzOkaQGkFbGRBDt5lXZz3yhqcOQDyRVYmhkS0xUEs4cquLPJfK/NzwWVPCf2ledQOhHUNb3tRCYLd8gkHGHo8lVgVAmOP/DBh0LpSkubS0p5mPTMHcQ2dwUmsOiJqMqyPaQXl+O7SjUr/gDQwE9RZ1zt8cokVGRjLVGDjQ/jCqmEAZXbZGB60dtGyH88lCpuVc9oQ7rEhZCFpTCfRRbSPGwDKqYj2w/nLAgSSpXGpHZ4m0tfb+5IJ8vCAHEA8QYuPLyXtyOxrAL3jrdhvfXpOj18Ojk8Erko1kFGajq/YklNiQ0thooVUwGH+Q1SqZIHYB1+NguEPdcrkMqP0cgMthKavDq/HF5e+3lwOUAVINN2knBixYsYyKmj1QjZXM0X48PD4NToIjlM2lNhkVLXvcJcDORcV2KrR64MvdytbdSpnSeDYP8xTOuoi0pXZddqtP3tMxLHT9CqHtdCx3PQM9CwsGdi1cWiOL/bbm5Kz3ngOq/AKIxX3W6xnV7E6lmw2+/gow2GYMAUGVzUHX3mDShOfmDLGX7IM/ypHmcP89yH9zy9MLa9WwBKJh2wv8gsdH7Gf9t0AbmESqnvbvfH+5Anq5Anq5Anq5Avofr4B6i54rbjsXQXX5w9OCW3NuSWl92zmubtqHqtHl1eXkEpbTciZuzgOP9jxQPmDZ7K2820cDZwX+RZt6Rd5gKkGwvq2Xuy97Beph2q1GSB7g3Pk334gtlw==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztV1tv2zYU/isEX5YAtpSkGTAYRbE0TjdvxRosaftQBAgt0TYbmVRJyk5q6L/vO6QsS4677WFv3Ystked++442PJcus6r0ymg+4mNZSC8dEyyzMpfaK1GwmTVL5heSLUyRS/uDY2tRgC5htziMz2wp7IMLVB1OKzNjcyYcy4PgfMC0YYXRc2lx6SurHVOeKb3PWSjnB0zovMNQORmoZ8ay0koHUkF2u54hXhZFNEQ5VwmdSTYV2YOEqEYNvc6tqTTMcSYcQVoJQZLlBjq08cwtzHp7VRWemRneBM69LBM+4KaUNmif5IhbZvRMzWP0xmquvCg+BnPelRIUl61j4CyFFUvQWcdHnzZ7CXiv1ZcKpgfymYLXUNzLhvMGL1tf9lMC+YrklMIv8Kyhicxr2WHtgFv5pVI44iNvKzngLlvIpeCjDfdPJdE7b5We87q+I+IYGkf3Zyfn9Ne3uRP8Js172Yz5aWO8EBRiNjX5E9m7kCIPwdjU9YCfn5yQBgTUg5keRVkWKguxTj870rjpWLzz5ROX1hp7aXIJqeF53LETrjTemelnmXnKhKUsehV923HvAqFgBUqP5D2KZVngDAbWB8Q/C16Hhb8WlLCy8qxNPoJbk7/PQ2nsXGjlgsOo4VCNK1GoHDf7bTIZE0WlH7RZ64T9GqqBtbWJRraSiQJVTlLESqhCTAsZWkgwh/6amseexkMZOf2OM/Jei8ovjFVfZf4sND9+18U6gT6raSRJu0LZBTV7MQKTk1lllX8K0+6iVL9LeryrBxv+WqI+7QUCHE7IazGnscibIcriFGVHYY6Ozz9cHkNBLHMKEqxbGBrAcfCE6UrCeLo6S+NQTvMoahhHVIooapWnLv+89umuldJNd0jWnOwmrw4N6bFcmsZp0FW2wNnC+9KN0jTH3VCUKlFzK7RPlOHkaV/AtTV5lYUG/4aYf5Jwg0Ahcd9id/F635C7XTZuqChjLW1z0haFiAcNlMR07sDkoumHUOR8vygurifsQT4x6hqKZuyFiACYYsC2gKSS3ffk3LOohi0r59lUEsDP1COgZK38AsTBJHbPjjDIZBDgLaZZiEEpMnk8YDKZJ3tiR6xhfPlkKkvhGMK4V/cJQtqrvg2fhrc3xi4FOpn/9vH2uW9ZJh12C4NtAs3h3Na8KKmxmaC5ZwRrIxgmAcUwKuNtl1PeODWL0jOzHSkiCyMFs0NRbl1Vlsb6n3f5bFOiftkd9QuhW0N73rRMsNussHGEtc/QFECEFf0vtyvWNmmxDQN8fJAWC0pAk91649hku3QdvQv9OjkOW9xhxuvOFrfr8etjssibzBRhtQPCUVVJTTyuQauvDcB5E/Y8OQirUFwZV6ThiTWN38FLQKULFeNBJmzuhsFfhTiwWWHWLqaziXSw9uOLS/bhkh2hHlBik6vbN+xmPMQbTqO2yc07dvrTyemL4Y9sOTZZuhy/7a3PoaQcASugQWIDoqxumwm1i7ieJSfPUrderxMRrhO4nDa8Ln07ubz64+ZqSDxIqle+6NVACFZusqrNHkTTJItpPzs5O09eJKfEWxrnl0J37IkrbMf8/SbooN3/Xwv/+muhaXMvH31aFgJztW7SvWkQ6xNfnYEwYhYFvYda8YMDuEVDhJCLSLs5GvVWfMz5BVJLUjebqXDyvS3qmo7xcWED/KIkhA1dGAEO6x+eAaUztIn8m6Qf/dksMcfsP/hYORiYLQxpwqAAGnjD4wOhVP9jpsYesUUo8iOS0KAufYf52VpWd5eH8dXbq9srkIsGC3Y4+BBwsHkgBQdt24fEaAX9EnIfZHlJXQpketWSx5tvMrQgEqkpUnfYr/4C6El+hA==
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 global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-global-configuration

---
id: config-delete-digital-wallet-open-id-global-configuration
title: "Delete global configuration"
description: "Deletes a global configuration for the OID4VCI issuer."
sidebar_label: "Delete global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWN9v2zYQ/lcIPSWALdmO06ZBUSyN085bsASL0wxoA5iWKJuNTKokZccz/L/vjpRkyZbXbQ97afrQyBLvePfdr49cexHToeKp4VJ4596AJcwwTSiZJnJCExJKEfNppiguILFUxMwYuRkO+p8uh4RrnTHley1PpsytGUagxkk5ZQM+5YYmDzSBXzcpgxUfre7LqmpQkVJF5yCgtHf+eb1j2L3g3zJGeMSE4TFnisjYmtJkp08+8gUj4+n+PsNoXHrhrCel6bpFxjOZREw1GFgVdItqglREZLxgytr2HfFiWUWBTwaSCGnIFA3HRWOOEpwlUeGpYqFUEYLNEZGUmhk8C8AMfjW6Cp8V+5ZxxSAoRmWs5elwxubUO197ZpWioDaKi6m3aXnsmc7TBN9NXkfduE977bPwhLX79E23/SY+7bU70Un4ir2m3Un/FCR2Y3RjH2jik4PR0oDTRD4TqaZUcO2yykiSaZbDwzVBm5k2PnmYMUFWMiOaAbz224xRgL7llDG14CEAkwltX5R4Ei7sC8gKw55NsTtiFTXagAqpgYyASE4pF9pYgaVNWicOnxutx8hj5Kpyc3isCbOajE+uGc3j7BwiMjMFDjsK/C/iixhV3QUJXUWDSJGsyLIAi2agAXAPqQEPuJlBNU8YVbCQhiHTICufmKjA2yAhyMXtkDyxVR1qQ5+YPhzJWMm5/ZoLW3D4VEjFahb7ZCQxbPk+bVwagrcYN3ogQBNuc4BZvQDVQSOsA+Pb+xEJFr3ANYaARnMuAppykA7W8PdXthpGmyDX0AYNY4LxA/ss4uM/2nfZxIUAi5c7tyOWQh0CTpHNJhfdql8VsDD7uMjQdWmhTyHDDHgCsUb1busbNUX9S9ic8Hib7hMJbji1epsDTQ7PM0g79sw16LbPE5ZIMcVdQZvaT9d8ETqTyBWLfHIhSCaehFyKStFiV9up4ebgFMVj66BQ6npiXYNd56xzoJCIxzFTsGDHSsiFOeSaq2L8FVOeuND+PBrdkn6nU3ZCB9K2F9ahrTXBmCb6n3bBV2dnb1iX9sPTSS8+6XQ6XXoSve52vM0jqtQp9G2mUUmv08c/9W442k6YyA7C6G/m1cj2d6cSIh+tEE02T80KvcyzAPbYgIXgOu5me5sw+EjTNMHiBVXBV427rysubr3/7DGlpLqUEQOt9nlQsRncyuGQk68sNDiTFfZUw52fW+ktchysmFr0S+TAwE2D+j20q2C/p9AoRAqVUdIAb4P/Wg2w1lIFgMpTtwX518xb5tQAHPoQI2iROiMIqXCZjGErBkklXA0h6f7AIbkXOECk4n+yaA+a0x86W4ewnwJKZGcCZJbdZgcjENIszBQ3K0t8L+xwgsdHpFjv7eS+AIDtG/SaTpEhezmxJo5ZkyPLrZGXH8MGQ5vJCBJYN5NIyl06W6KNyrzKdIycqrYbdwGgKHgUuGJp13I/WDeW0MZDJ9DFJvI+YHOZIwDrMpVg0zYm1edBEMG3Nsxjn08VFcbnsoFZ3ioZZaEt5QNqvqfhDlCDKB4S1+7zriGP29DcYYa6xCoCVGaIoxOHxtFFXhzFOaduWMmUthysnAgLmmSsIJDjmp5xwf2KWQ60JObPMGQc/XE2kjE5gk7mephRMEItBikN2XGLMH/q76g9J7ngW2QOCAdys3djH0djNRXXnqOUH6SC5gp+/PIw2vetQjehUrQuzHOacpuR9NWMICWCti3YE4kV8MqSx7h5WDlcxLLoLzS0/QUaCcfY6ixNpTI/beNZhoR/3L6qJ0I1h3a8KYXAbrkAVoPH5FBiSwCEOf6dQwSdC3nQXE3ao80ne+qjk4SRS+hvGGsgIwQLlQpgi0f5ofrY8qZmwVvgCOUWZcHfHqNFRoYy0Zg4MBExq5hAGZ1PSwetZV12yrXsKdaRNHsgXZG8C5CwYl6mbcYYWEZVpNvWXw44kDiRS+3CmSNtrX04uSSfLskR5AOk2PBq9IHcDdrwC9663YZ3N6R71umetE/JfCDDYD64ruyJWiClNE5ZmBMMGBFGtSgmyF3Ated39kK3XC59aj/74HKQy+rgenh59dvdVRtlIKiGm6SWAxasSIZZGT1QjZ3Mhb3X6fX9E7+LsqnUZk5FxR53x9HIOnbLoTIE//s9S57/eKoN0gROiWiWxWGd9/XP3qIHC51CtKHW291VDXR3eGjq7/D6vPkuAXrhDNzHDdbrCdXsXiWbDb6G07qy8wpgo8pmqhsCQNHgeUu7D8Jx9Hs+9Y8PXx38iBc9jdEuho7AiWNHBPyCxyecSQcugjbAJYrB9O9C83Kp83Kp83Kp83Kp8z9e6jR2Pdfd9q52yv6HlN+tubBBqXzbO3BuqseiwdX11egKltOc2G5J/ZMl9fkDts3G1rvL750V+D/a1CjyFksJkvVdudx9OShQMmK3GiF5hJPjX1kbGt8=
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 global configuration</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/global-configuration/{globalConfigurationId}"}></MethodEndpoint>



Deletes a global configuration for the OID4VCI issuer.

## 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 global configuration. Give `globalConfigurationId` for the issuer operations, `holderGlobalConfigurationId` for the holder operations, and `verifierGlobalConfigurationId` for the verifier operations. Do not give the `id` field of the record.","in":"path","name":"globalConfigurationId","required":true,"schema":{"type":"string"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The issuer deleted the global configuration. 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 global configuration matches `globalConfigurationId`, or the issuer cannot delete 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={"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 holder global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-holder-global-configuration

---
id: config-delete-digital-wallet-open-id-holder-global-configuration
title: "Delete holder global configuration"
description: "Deletes a holder global configuration for OID4VCI and OpenID4VP flows. The wallet keeps no response body."
sidebar_label: "Delete holder global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWF9v2zYQ/yqEnhLAlmzHWdOgKJbaaestWILFaQa0AUxLlM1GJlWSiuMZ/u67IyVZsuV1e+lLk4eYknjHu9/959qLmA4VTw2Xwjv3hixhhmlCyVwmEVNklsgpTUgoRcxnmaK4j8RSkevRsP9pMCJUROQ6ZQIfb0icyKX2yXjOyJImwIs8MpZqIiRRTKdSaEamMlr5XsuTKXP8RhGc7E5w5w/5jBua3FsOlnn00YrzwUozqAoDjFKq6ALIlPbOP693NLoT/FvGCI+YMDzmoJKMiQH5mjTzyQf+xMhktn/OKJpYvZGUa50ho0IB3SKT+SEBq4Q5qFVCxG/yxJSV7TvkxbYKA58MJaBryAwFx00TjhScJVGhqWKhVBFCzhGRlJo5rAVgBk+NqsJnxb5lXDEwjVEZa3k6nLMF9c7XnlmlSKiN4mLmbVoee6aLNMF301dRN+7TXvssPGHtPn3dbb+OT3vtTnQS/sJe0e60fwoUuza6tgua+OSgtTTgNJXPRKoZFVw7PzSSZOBQDh6uCcrMtPHJ/ZwJspIZ0Qzgtd/mjAL0LceMqSceAjCZ0PZFiSfhwr4ArzDs2RSnI1ZRowzIkBrwCLDkjHKhjSXInd+Sw+dG6dHyaLkq3QKWNWJWo/HJFaO5nZ1CRGamwGGHgf9FfBHjqrpAoatoECmSFVkWYNEMOADuITWgATdzSANTRhVspGHINNDKRyYq8DZQCHJxM4KoX9WhNvSR6cOWjJVc2K85sQWHz4RUrCYxpBaJZsvPaePWELRFu9EDBppy6wPM8gWoDgphFZjc3I1J8NQLXGIIaLTgIqApB+pgDb+/s9Uo2gQ5hzZwmBC0H8hnEZ/81b7Nps4EGLzcqR2xFOIQcIqsNznrVvWqgIXex0WGqksLfQoeZkATsDWyd0dfqxnyX8LhhMdbd59KUMOx1VsfaFJ4kYHbsWeugbddT1kixQxPBW5q313zTahMIlcs8smFIJl4FHIpKkGLWW0nhpuNUwSPjYOCqcuJdQ52n5POgUIiHsdMwYYdKcEXFuBrLorxKaY8cab9OB7fkH6nU2ZCB9I2F9ahrSXBmCb6v2bBX87OXrMu7Yen01580ul0uvQketXteJsHZOnKoEYmvU4ff+rZsFI8I1sOo2rtaCxbIGpucGC3AWFAS2Rs05gwuKRpmmCcwvbgq8aD1hVttop+9phSUg1kxICrXQ8r4oEGueZy+pWFBsuvwvRpuFNpS70FiYMUMwt0CRIIuGlgvwdsFdd3FHKCSCEIyorvbfCv1YBgvWMZDdHLck9tgqv7E8N1JzCPS8X/ZtEeNKc/tSeN4DwFnYlNzRB99pgdjIBIszBT3Kxs/3lhawQsH7DTeWcL6AUAbN+g1nSGjaqXd7nEtbnkqOiiB8dwgOt3ESSQbi6xQ3bJwPa7yMyrFKnIsWq7tBEAioJHgcsYgcsY7VpABOvGvm/joS6oaVMrPWQLmQMB+zKVYAo1JtXnQRDBtzZUR5/PFBXG57Khz7tRMspCG5AH2HyPwy2AB8Y8RK7d511BHrYWukVHdf5V2Kl0FFfcDxWHizxGiqmjLljZt2w7ItuvYSp6oknGinZuUuMzKTqxorJCkxDzZ0j5rhlxMpIJOYIK6YqaUVDQLAYpDdlxizB/5u+wPSc54Rus4wgHdkpvJz4WqqpHrj3X4L2XakEhur3f7sf7ulWaPwgYrQvxHKdcZmzBakKQEkGbHex8YAm8MvLRbh4GEBexLNIMDW2agXzC0bY6S1OpzK9be5Ym4R+2r+qOUPWhHW1KIpBbPkGPgdNuKDEzAMIcfxdgQadCbjQXmnbQ+GRnMDpNGBlAmkNbQ2tARjASUgG921E+GB9XJuNdwhtoAsojyri/OUaJjAxlYkdoKFjoVUwgjc7bHAet7YHsFNqyfYFrmex4uCJ5MiBhRbxMW48xsI2qSLetvhxwcBO7M2eOtJX2/mRAPg3IEfgDuNjocvye3A7b8ARv3Wmj22vSPet0T9qnZDGUYbAYXlXORC7gUhqLLZQLBi0PWrUIJvBdwLXnd/ZMt1wufWo/+6BykNPq4Go0uPzj9rKNNGBUw01S8wELViTDrLQesMZM5sze6/T6/onfRdpUarOgoiKPu3f4tx5rNyoqJfGH3prkkYPTaZAmMO2hQhbBdV4YPntPPdjoDkexa8XBXbxAecAq5opMy2sqEfD6vPly4AEptcGT1usp1exOJZsNvobxW9nKB8hTZZ3d1RFoz2G97aMPQnn0Z94/HB++C/gZb24azV7ULYFFy1YZeILlI5a1Azc7G+hKitr2/0zzckvzckvzckvzckvzA29pGrOey257dzVl/sOpwe25sEapfNsbXTfVAWt4eXU5voTtNO+Nt3PBo50L8gWmzcbUuzsiOCnwP8rUSPIGQwmc9W253X05SFA21W43QvIAM+g/sb8bhg==
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 holder global configuration</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/holder/global-configuration/{globalConfigurationId}"}></MethodEndpoint>



Deletes a holder global configuration for OID4VCI and OpenID4VP flows. 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 the global configuration. Give `globalConfigurationId` for the issuer operations, `holderGlobalConfigurationId` for the holder operations, and `verifierGlobalConfigurationId` for the verifier operations. Do not give the `id` field of the record.","in":"path","name":"globalConfigurationId","required":true,"schema":{"type":"string"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The wallet deleted 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></div></TabItem><TabItem label={"400"} value={"400"}><div>

The configuration 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 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: eJztWG1v2zYQ/iuEPiWAX5N0TYNhWBZnm7diCZakHdAVMy1RNheZ1Egqjmf4v+85UpYlR94wYNiXth8aWrw73j33Sq6jRNjYyNxJraKLaCQy4YRlnC15hiVT2slUxpz2e+z9XCjm5qLxmc259R/dKhdsEhuRCOUkz37j8aNIJoyrxO8bkXEnErajYNIy62SGRZBrHShaZHT8bqkTz6xmSampm3NXk9hj9zvCRyFyC11xss21soJNdbLqRZ1I58J45ccJrI61SuUs2D6SM+l49t5LuMkFKH6qGQvenBu+AKWx0cWH9R6AD0r+UQgmvTqpFIbpFACwm/Ho7N3VuG57JlMRr+JM7IFMBjzxDFIWhXVsKuCNh4fxiPSWdEbO3RxrBS3wq84MazqREX8UEsdEF84UohPZeC4WPLpYR+QgcFhnpJqBMtVmwR2+FIVMok0nEs98kWdE80Uy4MP0VHRPpq/j7ll8zrtv0uGwe8qnr+IvktfiPH0Djn3zb/yC3NAKhHcxwmGqn5k2M66kDSHkNCvgHigEGgQF2SCsKyNupQtmhY8i7M0FT4QJEWGFeZIxQqtQIQYrx24jCr514tltTyfQklYdOiGUpO0wPuNSAfpazHl2bLdqTwEONzT4Flg2mEWDp8feCv4k/PdgENOF2+KwJ6D3q/pV3dfNBYeto8G0ylZsuQWLF5AA3GPKpqV0c4TQVHADQh7HwoJXPwpVg7eFQ7HL2zFyaNWE2vFHYQ97MjV64XdLZg+OnCltRENjxLkmt5XndIk05qES8AMOmsqykhAxoDqohDdgcvtwz/pPJ/2Q3n2eLKTq81yCu7/G3x/Fapxs+qWELiRMGPkP+nnEJ79074ppcMEYdUwGsxORGxH7SkbRFLxbt6sGFkWfVAWZrj30OSLMwRL4msSHo2/MjOQvcTiT6S7cpxpmBLF2FwNtBvtKIZ6lheyyamRazehUSDMvw3VbWmBMplci6bFLxQr1qPRS1ZK2Q+7ZK2YHMjgkj8+DrdCOP6opwdMF7QIoLJFpKgwI9rRELCwQayGL6VfKZRZc+/39/S07GwyqkhhA2hXFJrSNopiiffxNVWxWwfPzN2LIz+JX05P0dDAYDPlp8no4iDYfSWRoKpaEnAzO6E+zGtZaUWhXyYvmSRaUHgb/BqfDLJLk65ZytOR5npXk/d8tSV7X1N9Z9iESxmhzpRMBqX49qukDlUtT9fR3ETtqZYbqpZPBhh33DhUJLWYe2QoVKLhpEd/SX3ZAfsNRBFSOqK+6Z7Shf50WyBrDxXhEUVVGZhtaw08YrQdFdVsb+adIXkDz6pMOpDHOM5hEfClG3fHH7GEEJiviwki38qPcpe8JWH6kyeYb3zAvAbD/QlbzGc18UTkjsjAksiM/JtJ8d4wDvtcZlSKQQ7u5pvkyJL8fHUlYVGtKSRDVDWWiDxSVTPr1DOivmxPeJiKtyaa2+XMkFro0GXSFyag4Opfbi34/wV4Xfa8nZ4Yr15O6ZYK7NTopYp96B8T8k4Q7wAS3HWK3YXtfkY87X9xRSIZI2nqkConQtg+V/csyG7ajelOxaiLZzTp7A3c5qE0acibbGWvbM9H+U/mMYh7GjKAjm7AjOCq0K2fQqjwGOY/FcYeJ3qy3J/aClYxfUocmOGgG+mrSoxZUj711FEa3b7fT+g/v71/aVhvrkBrWbtULkkqdabhqKMEqBH0dIAzDYVGV4+S3iFJFqlRvCwqPfUFB5ZDkW1vkuTbu650/K5fI73afmoFQj6E9ayom6K2fMD3QjTTWVAOAsKS/C3gwmFA6LSShv0K8EwYJw6e4Wl1V9y3LxtYWXGEqOypvY8d+PmlnvEV7r46oMvz2mDRyOtaZpcBBa6KoEop4bDnABGj9dCNxpOiwOWpCGIae6IQVK9O+dh1Ej7M+YhzIuEls19srgQNLM720wZ0l0l7b96dX7N0VO0I8IMTG1/ffsrtRF7/wNZw2vrthw/PB8LT7ii1GOu4vRm/rV9BwAbTUVtEYBIYZ8uo2mRC7wPWkN3jhuuVy2eN+uweT+yWv7b8dX13/dHfdJR441UmXNWLAg5XouKi8B9FUyYLbTwYnZ73T3pB4c23dgquaPuF+3pgO9tOg1u0+maeMMk3pktvPM1waCT3vrnXZbz5ETycgDB2HIGv0nPAagq5DOdvE9mLvbQE1eg63kMT1esqteDDZZkOfcVs3vnHCndz4DArNCdM81rux+6C7jn4ux4/j9qeD/+4NpRWwbXtR1Fs8J35h+UjdZ/+NZYP5YNt7/p2Vn99HPr+PfH4f+fw+8j++j7SWu1DWXrySVIWPpvpAc+mdUtt7cYnc1K86o+u31/fXIOfl7Lqb2x/93F4uqGy21tz9ET5oQf+TTq0sX1IqIVi/qsjDzkGGaugN1ATJR9wG/wI7eNKL
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWG1v2zYQ/iuEPiWALTkv3bqgKJbG2eYtWILFaTa0AUxLlM1GIlWSiuMZ/u+7I/VqSxn2pR/WfklkiXe8e+65F3LjRUyHimeGS+GdeWOWMMM0oSRTTDNhKH4gEYu54PjofxQfxV8yJyEVQhr4ggL964lZUkOoIOzZMKHxTa6ZHsCriKw79Oi1NiwlKRV0waJeM8hEkLk0S5AHdbALI5qpJ6ZAsV4xpcmKw9dfptMbcjoagdnewJMZU1bTJAJfQylivnAej/mCG5rc0wR+XWcMVtw0dh5XG4OWjCqagozS3tmHzQ6Ad4J/zhnhEYjymIM9MrbWvYiPzliIq50joWJWnCYWpTChPNVEsc85VyyFL5rEUhFr5vj0/Q0Bt0E6tLp9sJCjJRk1S3gWYCv+6vQGcBh4hWKAxKicDTwdLllKvbONZ9YZymqjuFh42+1g19tr+0ATn/T6rcGFuXwmUi2o4Nr5bySywHphltz5xrTxyf2SCUsLMDZy35aMRkwNqhDzkBGVCwdVFVHChcNOCgNUK3dH76NOGwYOeY5UXFAutLECK8sAJ46B6bIeg4Kcbcql8NgSZi0Zn1wx+sTse+cQkbkpcdhRYHNs2nQXJHQTDSJFsiarEiyagwbAHRjAHO8pmTOqMBvCkGmQlY9MNODtkBDk/GZCHtm6DbWhj2V+dWERK5nar4WwBYcvhFSsZbFPphLDVuwzxKUheItxoz0BmnPLAWb1AlS9RlgHZjd3UxI8HQcurwMapVwENOMgHWzg/29sPYm2QaFhCBpmBOMH9lnEZ38Ob/O5C8Ekgm/O7YhB7iBOkWWTi27TrwZYyD4ucnRdWugzYJgBTyDWqN5tfa0WqH8FmxMe13S39cyp1TUHuhxOc6Ade+YadNvnOUukWOCuoE3t07VYhM4kcs0in5xDIRaPQq5EI2mxLO/kcHdwyuQhrnY7pa6otzXYdc46BwqJeBwzBQt2rAQupMA1l8X4K6Y82aniZW1zINXVrQ1tq6bFNNEvFbWBx55pmiX47rvXr39gR/Q0fDU/jk9Go9ERPYm+Pxp52wdUqTMpoNmgkuPRKf5rV8Np3YRcO4teqvyOOaVWsqQIJnAgWqObBQ1gEyi7HviO29niJgw+0ixLiooffNK4/abhY+3+B48pJdWFjBhotc/jhtHgV4GHnH9iocH2prCoGu4craVr6DhYsbDwV9CBgdsO9XtwN9F+R6FSiAxSo+qo0GO26O8+ri2uAO8K7rpaFbnuXdZfx0dslCVDAWWZPCFDAeK+TowRsCUmR2wheLO+pjkb7E80L4V68OIEADa2h54BsX1xzy/FYtgpKqoSEqyLKUdfMVPuBDY2qfjfLNqD5tVXnUQT2E/BqFZWKLvNDkYgpFmYK27WdrQ9t00THh9w9HtnJ4pzANi+Qa/pAmdgr5ieiRufyUE5mV4cwgbv7XAKZoEA2LeUOHs7+tphGtV5jb5dkH7oSB8AjoJHgY4+rUzQTKFhnULBpi9Ttx66hA53DetjlsoCD1iXqwRbizGZPguCCL4NYWrw+UJRYXwuvf3590bJKA9tFveo+TcNt4AhxLRPXLvPu4Y81IG6Rb46mpXhqvjihp6+pnlepAotzjVtw6p5rp4Uq6b1RJOclWPurKVnVk6o5cQBkYn5M1QtN6Q5G8mMHEBdds3eKGj0FoOMhuxwQJi/8HfUnpFC8A3ONwgHTpBvZz428CYxN54bfH+SKqWQ5N6v99N93xpDMeSN1qV5TlNhM46mLSNIhaAtEoih28yrCgDGDQ9KgHgsy2pDQ1ttoKxwjC32F6nMj3U8q5Dwn+tXbSI0ObTjTSUEdssnmL3w+B5KLBCAMMf/adV3iqC5DLUHMJefdJ4wclEdPDWZaJ1TATPtwbVN5cmhne66BZtn5Tr9bw7RIiNDmWgkDjQ6ZBUTKKOLlu6gtbMhhy3ZgCxlUoyS9ly7rtpg2DAv15YxBpZRFemh9ZcDDiRO5Ko4/RdIW2vvTy7I+wtyAHwAik0upz+R2/EQfsFbt9vk9pocvR4dnQxfkXQswyAdXzXP4rGllMaeC10DWr8t52UyAXcB12N/tBe61WrlU/vZB5eDQlYHV5OLy99vL4coA0E13CQtDliwIhnmVfRANVYyF/bj0fGpf+IfoWwmtYHhoWGPu9bomzl2M6LRFf/nV0BFnuIdQZAlcOZG+Gy8NkUv+uA9HcNC140QqFY/crdI0JGwCmBPss2+syvBl7Peaxeo4EsIGm632czBgTuVbLf4+nPOlO25EGyqbH651gXTLzzXR5reCB78UUwuh/3XMl/yOqoT87JFCexPtqHAL3h8xA7Wf121hVGk7GT/DZVvd1Xf7qq+3VV9u6v6gndVnYXPFbi9G6uqBOIZwa05t0FpfNs7r26bZ6rx5dXl9BKW02ISrk8Bj/YUUDxg2eysvrsHAmcF/kWbOkXeYCoBWd9Wy92XXoFqhHarEZIHOHj+A7IPbW4=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWG1v2zYQ/iuEPiWALb8kWdtgKJbF2eatWILFaQe0BUxLlM1FJlWSipMZ/u+7O0qypMh7+TIMWPIhlkTe8e65d26DWNjIyMxJrYLzYCJS4YRlWgnmTG4d47lbaSPdE9MJcyvBtFlyJS1HipB9Lx8EfW7vnk6YVLSScbcK2Qye4Nsady0E4+zubjrpMathj4QDM2GIJYs1nK+0YzHJ4plvNFvkMnV95EknpdI6G7KLxAnjtwJxj3ZbYR5kJIAJS7VawnpugSedsydmTrMHnsqYwyHS2lwYy7iK2YMwMpHwFga9oJJrGgM8kVaJXHqQJnIpHU8/8BTerjMBO2bI/KKEAKgzbvga9hobnH/ctrC+U/JLDkfHQjk6EBHmfw92RBOEB/JOQOtcLZsP56TYfDQvuR0ClHEjCHxChq2EEYiCRHnRjvCsQCN4cw1dAZ1eYMSXXBoBQMGi6AU2Wok1D863gXvKkMY6I9USdibarLmDL3ku42DXC8QjX2cp7lm8ikfJKR/3X0cnon/K34z6b5KzcX8Yn0RfiVd8tDg9A4o2mNf0wNOQdcJKbgEYLPRjA0l0AnAOBgJ5/0AdhHUh+7ASij3pHLwJoKO1leCxME0fM7my3j6VAxduD77ixKMrT0fY4k4ZkCF34II9xpdcKnRNINiQY3lyWO6UHq2K1qrTreGxQdz2nXeCFzHrFWI6dyUOLQbhJ/VJzerqAoWtowGZIn1imxIsdFvEPcKg2ki3Ar9cCHAqw3gUCQu0+l6oGrwdFIpd3EzZvXhqQu34vbCHLZkYvabVgpjAkUuljWhIDMGj0WzFOX3cGoG2aDd+wEALST4giK/Th4UgBeY3dzM2eBgPfLoY8Hgt1YBnEqgHW/j9SUDA7AYFhz5wmDO0H8hHiM9/7d/mC2+CaQxrXu1YZEYgTjF5k7duXa8aWOh9UuWouiboM/AwB5qArZG9P/raLJH/Bg5nMtm7+0KDGp6t3ftAl8KUfsQj5I5emYow5+KpwM08d9cyX4EyqX4SMaRwxXJ1r/RG1YK2h+Zpp8buCPbBU5QMz7RHRzU50D4vnQeFxTJJIMEp15ISfGENvuajGN8SLlNv2h9msxt2OhxWSdGDtE+LTWgbSTHhqf2TrNjIgl+9fv1GjPhpdLYYJyfD4XDET+JXo2Gw+4wsbaYVlDRkMh4O8aeZDeue4Mto3FWkvcuU7NiKI4pg/PgJ9SvsD9x3INupP4eymnL4yLMsxbCFIwe/WTx3W1Nur/fHQBijzaWOBXCl50lNWlCoAEIvfhORw7JpMJs66TXcU+8xkyDFknCvMAMBdx3sO6rPHuZvOaQIlUFMVJU62OFfrwPQhpNge2P3lbJXT9nFAuCq0wd0RiouLQYF2O1qT15GUT2ddBlh9D82wp0qcPpdxM+gOftf++cUzjPQ/lDUQ7KjY1oYAZEVUU6tKXajF1SI4PEztlPfUpXGho6+oNZ8iW1rUDS6zHe67Ih63cnp+8tjOIBaXkjhEdgFoQIZVxpbZZ92qAdGlkGtHsaeYd+HywCwVDIeUCT0q0gYbNsd5i5ABVC9rm56Ita60B725SbF5OxcZs8HgxjW+lB3Q7k0XLlQ6o4O8sboOI8oNg+w+SsOt4AYWPAQufXLbUE+781yi97pnao0TuUdvm04VHYKmH4nbw/a3lF1RPteqzVFFI3ivMFnXvZ4Zc2G9iORj1BLfJvjZWRzdgTprpwCoVQSBhmPxHGPiXAZtties4Lwa+wQEA7swd7OQyyBdTfcBr51/K6cFn78MHuuW62thCixthTPcypkxuauIQSrEKSUQJMHEQRVuKPdAowaqRJd5hYeUW6BJCLRtjbPMm3cN3t7ViaR3+8/NR2h7kMtbSoikFs/QPcCExn0cpgOcErF3zVY0KtQGM3HI40w72l05YtUsEvIbWhraDrYFKZbrqAXOLqmwJ0eU3/UTXgDdas6ogr2m2OUyOlIpxYdBwoUepVQSGOL0uahpe6KBuoeW+m0aMZoqn5iReyzqCZebsljHGzjJrZ90lcCDixJ9cZ6cxZIk7QfTi7Z+0t2BP4ALja9mn3Hbid9eIOv/rTp7TUbvR6OTvpnbD3R0WA9eVc7k/kBlCZ8qBECuh+0ahlM4LuA6zgcPjPdZrMJOS2HoPKgoLWDd9PLq59vr/pIA0Z10qUNHyCwYh3llfWANWYyb/bxcHwanoQjpM20dWuuavJMiouQZqvQjoRa7Xu5xmlf4xQhjQP5IEthwEWkybTbokB9DB7GsNGXKMS2UaT8TRCUKeTVLFTw5fzZZQgk9RXYEdlutwtuxZ1Jdzv8/AUEpKIL9ueGQs5XM7AFPO/nhIPGPfqlaF2Ou+86/ptXSJ0WKGubQhRJGHiDx3ssfc+vmHbQqZSl759h9nI99HI99HI99HI99C9eD3UmPJ/Ynl0SVakPhwq/54KMUlt7Ns7u6uPW5Ord1ewKtvOidd6PDfc0NhQPmDY7s257gvBS4H+UqZPkawwlcNa31Xa/cpCg6rn9boTkM8ylfwDFoVlq
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWG1v27YW/iuEPiWA35NuaTAMy5Js81YswU3aDmgLmJZom41MqiQVxzP83+9zSEmWHLnb/XLvBZZ+aGSJ5/Cc5zznhdxEibCxkZmTWkXn0ZVIhROWcfYojJzJmNMHJp7iBVdzwYyItUl6H9VHdb8QzAqDdWzJzYNlblF+Z9yyxGvCo6KfxedEzqXjKVvxFF+xJkv1eimUY04XEkw6y2KdrXvs3iu0mVZWsAV0Ks2mOllX26fSOqYzYbyVlqWCPwqmcwf7y/2DRR02xdtgIU/qMtbJNMVblxuFvcOuhV+JFrSpg73SsZk2X3eiw6zGzjaPY2HtLE/hvF3V9WRGw0C34MGWSkMwtfL8o4o6UWXjOEFgYq1mch7CcxUMeO+lbzKBFe9q0foFqGizhoqMG76EgLHR+YfNXqjfKvklB9wJLIcszNQzb9VXIw94pGUyhHOSITwQ90uvi5XjZEJ+wnq3LlWWQSAMyMuJrC3qwVJJFmXcLfCsYDP9atWN70Z8yaURQMWZXHQiGy/Ekkfnm8itM5K0zkg1j7adSDzxZZbSuzPxOh7w16fdk+m3Sfd0Noq7r5PhsDuaveKD6TA+S04EJPZBuvEPPO2xg3BZMHyqn5g2c66kDbCBzjlIGygDtMhmYcGu9wuh2FrnoBgSw39bgJHCdIIyEE/GACxXAeKKBUwq/wJEcOLJlbsTWEmrDZ3AM2k7jM+5VLbBOS+Oz63WU85SqOpySzw2hEVDpsfe+OSj98Ehn4cFDnsKGvXDuwsJW0eDaZWu2aoEi+fQANxBSngg3QJpNhXcYCH3yYaNHoSqwdsiodjF7Zg9iHUTascfhD0cyZnRS/+1EPbgyLnSRjQsRmZoCluxT5eWxvCW4sYPBGgqPQeE1wuoDhrhHZjcvr1n/cdRP9SCPk+WUvV5JiHd3+Dvb2I9Trb9QkMXGiaM4gf7POKTP7p3+TSEgLK0yGIUMOQnpwpEbArRrftVA4vYJ1VOrmsPfUYJHaorqQ9b35g56V9hcyZnO7pPNdwIau2OA20OL3PQTjyhknXC81SkWs1pV2gzz+laLCqqsUChulAsVw9Kr1QtaTsUnmYOtwenTB6fB6XSTuhmDQ1+XbAugIL+MJsJQ02taSW4sATXQhbTrxmXaQjtL/f3t+x0MKhKYQBpVwyb0DaK4Iyn9u9WwW/Ozl6LIT+NX01Hs5PBYDDkJ8m3w0G0/UQqQ6u1pGQ0GNCfZjWst8aiZ/2dhnGgi8OLggvYaQs7T8OevsIpR488y9JCcf+zJRs2NUd3GHyIhDHaXOpEQKt/vqpZDucKUPT0s4gdtcbQfGTwdie9w0/CirmPQYUfDNy2qH+GeR3yHzFuSJUhP6puHG3pX6cF3AZhQL6CwJ2/GJ4KmgJlnT4K32e/GhQfBl9scgIYYTzUyTusfegxYoa6nhT1g6jQFs7hPzicbxW1IG3knyJ5Bs2rfzTTx9jPYKgqa4nfZg8jCFkR50a6tZ9dL3x7w+MnGtJ+9L3/AgD7N+Q1n9OQGxWzMQvDMTvy4/HV6bvLY2wQpmSYBQHYt9A0WQf6+mmZ1EW1DluQvhtI3weOSiZ9m3xeuX49v/qLMHL3N+1ptI3IG/K1bRC/EktdQIF1uUmp/juX2fN+P8G3Llp7T84NV64ndcuQemt0ksc+0Q+o+SsNd4AP4TwkbsPnfUM+7WJ0R1QNDCsjVVElTCaHOttFkSUesmifKtXQtRvn/LBJxfKRp7koZ9FJQ8+kHCPLsQBxmcknFKwwSQUb2YQdoW6GjuwMurHHIOOxOO4w0Zv39tSes0LwOxpCCA4a876f9KjL1jm5icJ0+pM2S478jn59f//ct9rkipSxtjQvaCpspvmxYQSrEPT1gTAMm0VV7lPcIkohqWa6LDQ89oUGFUVSbKn0a+N+2MWzCon8efeqSYQ6h/a8qYT8IRcDEl0ixJpqAx3q6e+yzIwyaCE5/SkppCafpoJdotBRrDHXsLG1OVcYPI9ufBaPj/0I1i54W0u+XebfHpNFTsc6tcXxlVglFMnYouX+WdwGYICT2FJ02EKnxbznM31ddcC4Zl5uPWMclnGT2K73VwIHNkv1yoZwFkh7a9+fXLJ3l+wIfADFxtf3P7G7qy5+4W3YbXx3w4Zng+FJ9xVbXum4v7x6U9uTtIBSltotGobAUEVRLZMJ3AWuo97gWehWq1WP+889uNwvZG3/zfjy+ve76y7JIKhOurTBAQ9WouO8ih5UUyULYR8NRqe9k96QZDNt3ZKrmj3hvqI5iyyq64mk2VmqbvhyC/X/cwtVVBS6cuhnKY7wFGjPrE3RMD9EjyMsDC2TotpomuEiC22T6hU1zsCeKqjU9itCnB+480GjWYBbtNdmM+VWvDXpdkuvv+TC+KkAWrnxZSB0WAzReN4djw5y7ehfxWx1fPiK539xI9YKfNlRFaHl+x9+4fGBGu6hG7MtRqay7f5n2Lzcfr3cfr3cfr3cfv0Xb79ay14ob8/uwKoCSAeasObCB6X27dm5els/+11dv7m+v8ZyXoztuyPLgz+yFA9UNltr7/7pJVhB/5NNrSLfUSqBrN9Xy8OXgwLVvB9WEySfcED+N6ky1bg=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztV11v2zYU/SuEnhLAlhzHXdugKJbG6eatWIPlow9tANMSbbORRZWk7LiG//vOJWlZdpzudUCXh5iieL/OvbznahVlwqRallaqIjqL+iIXVhjGWamFEYXl9IJpkSqdsbFWM2angi14jnNMjd3TVOWZ0DG7wRpSpSoMNrlhhWIjlS3jL8WXgl4aoedCsxnXD8ZJBr04mjnDWBb0GF5nciItzzfmMlHmajmDV8yqIMGkNSxV5dKbz6WBW6XQzm/DcsHngqnKIqKNCW/Unw8eZUqQtxaWpGVjpX9svsWMgkJTpakwZlzlcNssmnpKrWDXTrlt4rXxoPY5AKMRhkPr7pTBHUOQO2yxWwcTs1tD4TKewzr5yDf4OTtLVQHZDMaknTqr0IYDQhICtZYvRdSK6sdBhqSnqhjLiU9938f8yTn8sRQ4cSe0HMvUnYdsyTWf4aQ20dnn1V793BbyWwUvM6AEIUASauRQOcnih8WE4KWvg2FTepANCV5EYJcbIa+w5aAncIeycSiG05KcK7mdYl3AfXra0Yl9Lb5VUgsgYnUlWpFJp2LGo7NVZJclSRirZTGJ1q1IPPJZmdPe6bjLX6Ynr9qvRz3R7mUd3n6V/jJun4gXoy5/nfXSl6fR+p60+4thSGG306OfXexunhbKM8hRRFOBXFMOVms41Ot0SCEyaXGWlrws85C05KshA6tGRNtYP0dCa6UvVCag1a37DbfgeYhejb6K1FIBeFylD2UrvQVKwouJ0FEDKDi4PqD+CbhNbN9xqpESl7euuWhNf60DyO3ANOhT6VTFQ6EWRYuF+6z0hBfSBCQrtAdUoEHHGalHNkMIMfvdVV+zg3BcTiorPucy56NcUO/ZCDU1mkNZOfmJs3Jb8MpOlZbfRfYEmhc/dcEOYE8XoJbAP87MHkYQMiKttLRL12jPS/mnoOX9urWK3gkUpj4HwG6HouYT6shR6ODMt3B25Jp4v3d3cQwDvr4JJHg3VdT9fa9xjZ2URcm8m3hGSAIBtn1XSoBiIbPEZF8XNpk3WCFZ7TbTdUS+U2SHOKIvZioEjnOVzrE3tbY0Z0mS4V2blzKWE80LG0sVUbS7Cq60yqrU3eJn1PybhmuAheQ9J278631H7rcZuabC9PW0yUtdGNxvBNLxKd3Sznm4Exs63XXs/GrAHsSS0c0hCk0D9VOHm/Mc1BoYb7ijZ8i8GTarMP+MXDccy0cwiBsGht5HNmRHaGXCKbAa/cxhUPJUHLeYiCfxntozFgTfYLjQBEcbzr0dxsSBzQpcRSP39F7pGcdtjv74dPM0NjctoX0+iAIXxJiNe15T8Jl68o4TrEbQdQPC0BuL6ptOeYvowshirDZthaeuraB/SMqtqcpSafvrNp91SuRv263dQmjW0F40tZCb9TDw0NCcKuoENJXS76zmo5A0fxXd7OaHKscnF2hrlGvMdWxgTMWLVODaujs7OHYT8WHBqybl1ff86pg8sipVuQljFFWVKEjGBMr6HtgNXCZhUrTc3NVyxtzNXtbTb9pwrzKuYiyOcZ2ZtotXAgc2ztXC+HQGpJ23n04v2N0FO0I9oMQGlzfv2XW/jSfsemuD64/s5FXn5LT9gs36Kk1m/Q8Nm6QFJeXIFfQgMEFRVjeXCbULXLtx50nqFotFzN3rGCEnQdYkHwYXl39dX7ZJBkm10uY7NeDAylRa1dmD6jCU41y30+3Fp/EJyZbK2BkvGv74GZrNdyfmbJc/as77/2vr5/jaCl3KikeblDkHLaxDta4C6X6O5l0c9LRLFbNDvP6DDdRLPZDI11dks8TO9r5mQFVTVCdpXq1G3Ihbna/XtI3PM+2mCOjg2jUSz9EYY7HGRDBGyOIHVXv0d5jFjtl/9XPvIOIbei6Imx2Z4gnLB2Lv/c/BNaasDXcTPP4QUVhpG+JPhtZ1c7TqX364vLnEcR5YcjshPLgJISzIwEHv9ocF7wX9p5nmoMgb6l/g7Lf1cf/mWYGaXv1pwuoe0+c/paxYVw==
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 verifier global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-digital-wallet-open-id-verifier-global-configuration

---
id: config-delete-digital-wallet-open-id-verifier-global-configuration
title: "Delete verifier global configuration"
description: "Deletes the global configuration of the OpenID4VP verifier."
sidebar_label: "Delete verifier global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/iuEPiWALdmO06ZBUSyN085dsASL0wxoA5iWKJuNTKokZccz/N93R0qyZMt7wYB9afqhkSXe8e65t4dcexHToeKp4VJ4596AJcwwTcyMkWkiJzQhoRQxn2aK4hIiY/vtJmViOOh/viULpnjMmfK9lidT5pYNI9DlBJ3GAZ9yQ5MHmsAvKxx9zgU/2m0uq7uAqpQqOgdBpb3zL+sdK+8F/54xwiMmjNVRmNVksk8+8gUj4+n+PsNoTGKprCjXOkNFhQu6RcYzmUSNBlYF3aKaIBURGS8O+1cVL5ZVFPhkIImQhkzRcFw05ijBWRIVnioWShUh6BwRSamZwbMAzOBXo6vwWbHvGVcMgmNUxlqeDmdsTr3ztWdWKQpqo7iYepuWx57pPE3w3eR11I37tNc+C09Yu0/fdNtv4tNeuxOdhK/Ya9qd9E9BYjdGN/aBJj45GC0NOE3kM5FqSgXXLsGMJJlmOTxcE7SZaeOThxkTZCUzohnAa7/NGAXoW04ZUwseAjCZcOlb4km4sC8gKwx7NsXuiFXUaAMqpAYyAiI5pVxoYwWWNnmdOHxutB4jj5Grys3hsSbMajI+uWY0j7NziMjMFDjsKPC/iq9iVHUXJHQVDSJFsiLLAiyagQbAPaQGPOBmRiiZMKpgIQ1DpkFWPjFRgbdBQpCL2yF5Yqs61IY+5a2iEYtYybn9mgtbcPhUSMVqFvtkJDFs+T5tXBqCtxg3eiBAE25zgFm9ANVBI6wD49v7EQkWvcA1hoBGcy4CmnKQDtbw9xe2GkabINfQBg1jgvED+yzi49/bd9nEhQCLlzu3I5ZCHQJOkc0mF92qXxWwMPu4yNB1aaFPIcMMeAKxRvVu6xs1Rf1L2JzweJvuEwluOLV6mwNNDs8zSDv2zDXots8TlkgxxV1Bm9pP13wROpPIFYt8ciFIJp6EXIpK0WJX26nh5uAUxWProFDqemJdg13nrHOgkIjHMVOwYMdKyIU55JqrYvwVU5640P48Gt2SfqdTdkIH0rYX1qGtNcGYJvqfdsFXZ2dvWJf2w9NJLz7pdDpdehK97na8zSOq1Cn0baZRSa/Txz/1blhkArgd2YEY1Zt/8+Aa2UbvdJMZRUghE6IVOpsnA2y1AUMBAdzUtjhh8JGmaYI1DIqCbxqNWFc83YLwxWNKSXUpIwZa7fOgYjp4l6MiJ99YaHA0K2ythjt3t9JbADlYMbVBKAEEAzcN6vdAr2L+nkK/ECkUSMkGvA3+azWgW8sYyL48g13Hihz9KLqwy8o5Jlqep4CyTBaYpwBxnfEg7ra9ZIgoBO4Ak2iRfKLvbKZYDI08yhsGxr4pfN0fOHz3AmeOVPwPFu1Bc/pDZ/YQ9lPAoormYbfZwQiENAszxc3KcuULO8/g8RFZ2Xs77C8AYPsGvaZTJNVezsmJI+XkqOD0l8ewQcHOESawbyaR0bv0tewc1XmVkZonfdslfQA4Ch4FRX8LXMm0a5UVrBsLaeOhP+htE/UfsLnMwYB1mUqw5RuT6vMgiOBbG6a5z6eKCuNz2cBLb5WMstBW9gE1f6fhDgCEgB4S1+7zriGP2yjdYbK6HCtiVSaLIyOHhtlFXifFKaluWMmztgyuHCMLmmSsoJ/jmp5xwRwLJgCkJubP0LIceXI2kjE5gk7phrBRMIAtBikN2XGLMH/q76g9J7ngW+QdCAcyu3djHwdrNSvXniOkH6SaU6hw79PDaN+3ClmFotG6MM9pym1GylgzgpQI2g5hzzNWwCurH+PmYRFxEcui1dDQthroKRxji71fKvPTNp5lSPjH7at6IlRzaMebUgjslgvgRBrYTyixOwDCHP/idGo4ctuDkStOOkkYuYRWh7EGKkOGcISlArjm0Y2t4+GxZV3Ngrcw8sotytq/PUaLjAxlojFxYDxiVjGBMjofsg5ay9nsqbllz8CO4tmKX5UzMKyYl2mbMQaWURXptvWXAw4kTuRSu3DmSFtrH04uyedLcgT5ACk2vBp9IHeDNvyCt2634d0N6Z51uiftUzIfyDCYD64re6IWSCmNAxdGBgMahVEtiglyF3Dt+Z290C2XS5/azz64HOSyOrgeXl79enfVRhkIquEmqeWABSuSYVZGD1RjJ3Nh73V6ff/E76JsKrWZU1Gxx92U/DUn3K2LymD8j3c3eTXgCTlIEzhxopEWlXXe7r94ix4sdDrRkFrLd9c/0PSdx254tLymxg+vz5uvKKBJzgAX3Gu9nlDN7lWy2eDr7xlTdqaBdqpsCrvpAJQPnrds/iA8R7/lzOD48I3Ej3h/1Bj4YhoJHEV2dsAveHzCYXXgfmkDfKOYWP8uNC93RS93RS93RS93Rf/jXVFj13Pdbe/GqOx/eBZway5sUCrf9g6lm+rBaXB1fTW6guU0Z7xbtv9k2X7+gG2zsfXuEn9nBf6PNjWKvMVSgmR9Vy53Xw4KlFTZrUZIHuF0+ScVaECT
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 verifier global configuration</h1>

<MethodEndpoint method={"delete"} path={"/v2/config/digital-wallet/openid/verifier/global-configuration/{globalConfigurationId}"}></MethodEndpoint>



Deletes the global configuration of the OpenID4VP 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 global configuration. Give `globalConfigurationId` for the issuer operations, `holderGlobalConfigurationId` for the holder operations, and `verifierGlobalConfigurationId` for the verifier operations. Do not give the `id` field of the record.","in":"path","name":"globalConfigurationId","required":true,"schema":{"type":"string"},"example":"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45"}}></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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>

The server deleted the verifier global configuration. 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 configuration has the supplied `globalConfigurationId`, 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 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: eJztWFtv2zYU/iuEnhLAt1y6dUFRLI3TzVuwBIvbDmgLhJZom41MqiQVxzP83/cdUpIlR14xDBgGtC82JfHcvnMl11EibGxk5qRW0Vk0FKlwwjKtBFvyFA8sV9IxN+f0U73MjH6QiTBswRWfCdtjY3zUZsaVtJyYsUVuHZvzB9FKF/OMT2Qq3YoJxSepSAILI2ymlRVsopMVk5aJReZWvagT6UwYz3mUQNFYq6mcBXWHciYdT995EdeZwI6wfgPVQZlxwxfYZ2x09n69YzH2fM4Fg1LKyamEanrKeMN4I2bSOlOY5Q1O2GTl7QqC2E1hFykqiW3G3RxrBcF4WlbqQPlOZMTnXBoBO5zJRSey8VwseHS2jtwqo/2QJtUs2mw6u+pe+wVPe6xVcVLJcpVM9GPTG06zHKhOtcEewEoqCOt67N1cKLbSObNCJeHbXHCY0gnMhHmQMfySK+tfVG5gUvkX8IQTj66UThYnrTp0QhRJ22F8xqWyjYjy5Pjcqj3eMaVdg26BZYO4GX89diXK4AsGMZ27EocdBr0P6oMa180Fha2jgYxIV2xZgsVzcADuMXewQLo5QmYiuMFGHsfCglbfC1WDt4VCsfObEbsXqybUjt8Lu9+TU6MX/mtB7MGRM6WNaGiMfNLktkJOl7bGsJb8xvc4aCJ9DAjPF1DtVcIbcHfzZsz6D8f9kIx9niyk6vNMgrq/xv+vYjVKNv2CQxcc7hj5D/p5xO/+6N7mk+CCUXJH6U4SE5EZQTglPpqCd+t21cCi6JMqJ9O1hz5DhDlYAl8T+yD62syI/xLCmZxuw32iYUZga7cx0Gawr2biEXWgE9YTkWo1I6ngZp6Ga7GJjEn1isrbuUI5uVd6qWpJ2yH37Baf9gwOyePzoGTa8aKaHPy+oF0AhSVyOhUGG3a0RCwsEGshi+lpymUaXPvzeHzDTgeDqp4FkLYVrQlto6ZNeWr/rqh1IvHIF1lK7757/vwHccRP42eT4+nJYDA44ifJ90eDaPORWIZeYInJ8WBAf81qOG7pLInvCUm9tlAV/1J7KaIAMlB1o9Mgzdc25WjJsyyl5IXg/idL0tc1E7fWv4+EMdpc6ESAq18PazrDrAIOPfkkYt+eDNVUJ4OdW+otchJazDz6FXJQcNPC/gnadbBfcRQKlSEzqo6IFrMhe/fC6htgokWIuyIBfBPZafdFZPJdf7Rhe/QVY/tGUSfQRv4pkifQPPuqw24EeQazjS/uyGQvZgcjEFkR5waDox/mzn2XwfIjzUqvfAs+B8D+DVnNZzT1RcWMWM5rB35MHJ6+vTiEgJ0hjtCCmnNNg2YoJ36KJK5Rrd8lgWc3RHwfcCqZ9MNTt4z/8pkSqb+uD4KbiGwhS9vm0qFY6AII7MtNSkXYucye9fsJvnXRX3tyZrhyPamjp5MirEny2OfmHjZf4nAL8ODMfeQ2fN5V5OPWQ7cUqCG+Sj9VgRLGg33t5bzIER/40W6gVJPPdqbyEx/VrQee5qIcCO8afO7KWa7szRgzpvIRvSKMM0FHdscOUMlCW8TUj0MKYZDxWBx2mOjNejtsz1hB+IImAYKDZq2Xdz1qdfWIXEdhRHytzYIju6Nf3o2f2lYbH5Ew1pbqBU6FzjTENZRgFYK+OhCGQVhUZT75jY4UQHyqyzLDY19mUE8k+dbmWaaN+3Hrz8ol8qftq2Yg1GNox5qKqOwHFh0i1lQZgLCk/wU8GEwonBZS0x9V3gqDoYaOh+wCZY58jeGCjazNucL0d3Dtc3h06OegdsIb9PxKRJX3N4ekkdOxTv3hFe2LoiqcRW3R2gK0foqSECk6bK7TYuh6IAkrVtQAFtfUy62PGIdt3CS26+2VwIFNU720wZ0F0l7bdycX7O0FO0A8IMRGl+PX7HbYxRPeBmmj22t29HxwdNJ9xhZDHfcXw6uaTOKCkLLUbNEuBCYc8mqZTIhd4HrcGzxx3XK57HH/uQeT+wWt7V+NLi5/u73sEg2c6qRLGzHgwUp0nFfeA2uqZMHtx4Pj095J74hoM20dDs01fcKpvT5h7GZBrQX+n68kisSi428/S3GcJHs9wOuiXbyPHo6xMTQMsrLRMsKtBpoGFjttY/umwOescYeAIjsHriRgvZ5wK96YdLOh1zjWG98P4Q9ufAqE7gIQyKZqPt8L+MHvxVRx2H7H8K8uR1ohK1uCon7gCziesLynjtG8PNmgz5fd4p+Z9e3m5NvNybebk283J//hzUlrsQtF7cn9SVX2aA4Pe869U2rfnhwGN/WTyvDy6nJ8ie28mDa3k/a9n7SLBZXN1oq7O3QHLeiXdGoleUGphGB9WW0PX/YSVGNq2E2QfMSp7i/dM6lu
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 organisation admin
Source: https://docs.igrant.io/docs/openid4vc-api/config-delete-organisation-admin

---
id: config-delete-organisation-admin
title: "Delete organisation admin"
description: "Deletes an admin from the organisation. The service gives the admin as it was at the moment of the delete."
sidebar_label: "Delete organisation admin"
hide_title: true
hide_table_of_contents: true
api: eJzlWFtv2zYU/iuEXpYAviVNgcEoirWxu2lLk6BJk4cgQGiJtthIpEpSdlJD/33nkJQsyU6TdsBe6hfrwvOd+03rIGY6Ujw3XIpgHExYygzThApC44wLMlcyIyZhRKoFFVxTPDggl/BEM7XkESMLvgQKPONIqCbckBX8UWMfZzJjwhA5t3exZTEIeoHMmbJ4YQysIynmfOEEOGswe4egcDqnimbwTulgfLMOBNwAlWUJ9L2Ao/w5NQlct5X6LPjXgpFwgiKAZhWiYl8LrhgwN6pgvUBHCctoMF4H5jFHcG0UF4ugLG/xsM6l0Ezj+8PRCP/abJo2cUrGG6ugvqChAUMgJc3zlEdWv+EXjeTrbfZy9oVFBlVXaCrDHXOLt+vYRp+bgKNJAI6n8G9tBTCJFPivZMqsyfDi1L2jBYgqjJcJDzMRg/KhWHLjnt12BQEeW7Z6wvY8RvA5Z4rMpdqYJSgrKXcgwcmMgrlqPdrQ1o2/aWLfAlwMLtII6ELjOck+FGlK8GgVmLVAzk7PAlT87XEiimzGFJLzjC7Qvv/VNgBtoWrMz2qnmTqgn06IkbtR2AOkj6DpS4Sb+rPfdZ17Zx7PlVzCtXoJcOhpSO6JIDERy0flhp5DtizApF2A0yJjikc+n608WvOFgHRDjArr9EVR8FeRUdFXjMZ0lrJWPFRgndTYkXhtyGNbyApX2qzN2ggEqlgiY72V2DnosZIq/hkWFS3ZTuQWDyZQzyaLmQQ9KbizBF0lj6NzD5ViOv2EKE16ciIX0BJW3CRk+nkSkmuaQmX8AbG6/K4TsB7byYVDLXA4daQW2uVkysX9D8FXxCSBPuao8RlXTTWeULcTNFIdQ1HGG5pOH6KEipeVhw0VqcgaMc+1LkAm/qeiwgy4JO+aHElUE6Nj0bXbBf15a4RAAnjQ3vm82eGjSBbQ0dE2lHhgwjfIGEm2hX+r+/vPF8MmUhf5ZUl+2sjqNpr/9YKj0QHivLhFN3stUwp8LGPso/Z60uAOXfP77XxDvav0sQea5VCHxkejUbkDfofuNUnwnkKAiLwwpB6eqmjoGh/jVSr+jeFckEA5tHPW2pnm6Bc2zSemZaFgpBMS870Q2wZ67abBX9RAofCDAs6+kLaWTcdGQKRZVCho+3Z4f8+oYgorFtze4nht6ALn+mDCF1BE0qrA7p1BdQknR1fH+wB5yWhGPlIB4wxuFGgf10tBDDdx2z0BUYPh8nAoxUxSFQ+bu8vQlrDh2i8OZYCioeBureiuQ5n0esG5AuevIDEm1+PhMIZ3fZrzAV/4EgzFqQsAg1FcRLY1PgHzHMIFWAar6xPk2r3uCnK7MfgFxp0Ll3c5/4c9NvxO3QO/PDmPVfsCDLi+JlSTRGf8PQ/JPXvsDBxuNVzStKgr7l0L5444NiQrtCEzBmMgm/MHaGV2SLhzMpI7sgcJxyyAUTDgWxvkNGL7PcIGi0EHdkw84ZtHSFc0Rx+Ee3s3wI7RDLd1MLN3H6rl4u/ry23dogi7uZH3TNjRqhLPIXmZIT9ISwhSW9Amu+2sliCoExn9FmA+cDGXVdWgka0afhEKdJHnUpk/Nv6sXVK3+61AaMZQR5vNjOBHbuzakcREBwtz/Md0cip4p7m8sz34CqbtObfj8WYk0SSEAYQKKIx7ZzZBw33YreMnCM9hN6tZ1El9vo8SGRnJVGPgwACHUeWGON1q1egMN/P0SCLTuGeZLZHDI4l90Yga4hXaRoyBY1ACdN/qy8EOZJ7KlXbu9Ja20l6/OiZXx2QP4gFCLJxefiAXkz7cwVPHLbw4Iwe/jw5e9V+TbCKjYTY5afAkbl/VuOpD9WdC27JcJRPELtj1cDDact1qtRpQ+3oAKg89rR6ehMfT04tpH2nAqbA0pa0YsMaKZVTU3gNorGTO7Yejw6PBq8GBXWmlNrDoNORxH1pan3X8XtcJn0Zj+38/D/mMMbC1DvOUurm6cDuwK/I3wfIQvyO5Mh9Uo6GubFHpM66+EkFZTMASSLlez6jGlbos8THMngp7E1wuqbJB6/oBoLnNZA5Rxb5jm71Pvq3vk6c+OO3UqCrFAuuwLZxwB5f3WKnr71vlbVm1VCuXe4t1KjcNuq3Bo2z2yMn0ZHo59V97muN/VaT8BTLYKdYbX/8usTC+rYW0dRJFLMt/AarAFrE=
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 organisation admin</h1>

<MethodEndpoint method={"delete"} path={"/v2/onboard/organisation/admin/{adminId}"}></MethodEndpoint>



Deletes an admin from the organisation. The service gives the admin as it was at the moment of the delete.

## 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":"adminId","in":"path","description":"Unique ID of an Admin","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service deleted 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"}>admin</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 for the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"email"} qualifierMessage={undefined} schema={{"type":"string","format":"email","description":"Admin's email address"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full name of the admin"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} 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={"roleId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Numeric ID of the assigned role"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the role"}}></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"}}>

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><SchemaItem collapsible={false} name={"pendingInvitation"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the admin account has a pending invitation"}}></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  \"admin\": {\n    \"id\": \"string\",\n    \"email\": \"user@example.com\",\n    \"name\": \"string\",\n    \"phone\": \"string\",\n    \"imageId\": \"string\",\n    \"imageUrl\": \"string\",\n    \"externalId\": \"string\",\n    \"identityProviderId\": \"string\",\n    \"roleId\": 0,\n    \"roleName\": \"string\",\n    \"authentication\": {\n      \"password\": {\n        \"enabled\": true\n      },\n      \"oidcPasswordless\": {\n        \"enabled\": true,\n        \"linked\": true,\n        \"authenticatorCredentialExchangeId\": \"string\"\n      }\n    },\n    \"pendingInvitation\": true,\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={"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 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/iuEnhLAlnIrMARFsTROO2/FEixOiqENEFqibTYyqZKUE8/Qf993SFmWHaXDntMXWyLP/fYdraJM2NTIwkmtotNoIHLhhGVaCWa5ysb6iWkz5UpaTiRMT5ibia2zmH2UC+GPO1mGAyaVvy64m8VsRITCLGQqmBFzvYA+un3kOZSvNXSKwhkDlSfIuOMkWLr4q/qq/tYlS7lS2rHMO+GJ5hwUQXDMhkHyFNYGq+wuTS+oro0jQst+G42u2MnBgddyNnHCBPWkBDb1YBQ7uxqyB7HEBXckdqxLWOo0DvDW6YrSLNdqCmlGWJ2TJt5Y+l4SO7Q0gjVuMzmZCCOU65TYw1tQuePSo3Qzdn91M2JJqtVEThOezaVKeCEhOlnh/w+xHGZVUovtQ+x9HPUiXQjjZQ8z1EZgDhVyHSgvzRRkBTd8jkNjo9Mvq52KulHyeymYzGC3nEj4+4MEk1JJXFQpeFaQizfbaIMhvciI76U0AjY5U4peZNOZmPPodBW5ZeHpnZFqGlXVHRHbQisrLN0fHZzQ37aF7XoMpZO9bKCv3rVMNuOWEjnW2ZJMnwme+SisqqoXoWZIGcLm4Ds98qLIZeoFJd8sKV+1jN+49SUSxmhzrjMBqf550DIZXtWO6vE3kTpKgaFcORnc3HBvYiJhBaqN5D3xeZHjDAZWHeKfxbHFEr3nGZquKB1rso44V+Tv86j+sNN4XeLr0G83L7q6I6CHrzigN4qXbqaN/EdkHaE5ecWhGe0g0rovOwevH4d+Lg8Hz2vszatu2iH0GcVz35QY1V7NTozAZEVaGumWftyfefjA413VW0XvBTfCnKFS/Ql5zaeEC9FATqWD6M8B5vcuC6GGg5Pb830oqPEEkQAHDJxpQpwwCzzCkLwoWRytIawFVcmqjQ9VRPaR9V1oNMC+UTsHutLkOJs5V9jTJMlw1wcYxnJquHKx1BF5tC3gyuisTH0hvSDmvyRcIyBI0EvsNlzvGnK3ifo1FV+omXXsm+QHLF+jaEjbBkfP6gHiiznaTf5616AxQ2CdthBvwXOAeI3c91ty7llQw+aldWyMLc+IiXwCiIbFI9jI7tkexnvYypzhMvcxKHgq9ntMxNN4R+wpqxnfLnVpKBx9GPcOewkKsF1lq2js3z5oM+fo2Oj3z6PnvqWpsAAh/QBAKri1a/OCpNpmWie3jGBNBH3HUwyDsqjpZspbRE0h1USvRwdP/ejAjJCUW1sWhTbu100+m5TIj5uj7UJo19CONw0T7NYLrFa0O6aaup2gk/7nyODWxh7ajU2wJN4Kg02Mj3PBzjG6KNc8xzi0tuQKSLx36ftyuO8xupvxCjtQo6Lp5at9ssjpVOeWCgdDlqpKKOKx9RwOoaVkYC+wWODYTOdZWAgWpGGJTTfMirRlXml9xTiQcZPZvvdXIg5skutHG9JZR9pb+/n4nN2esz3UA0pseDH6wK4HfbzhNGgbXl+yw18ODo/7b9h8oNNkPvjU0klSUFKWUAIQILDxUVbXzYTaRVyP4oNnqXt8fIy5v45pPtW8Nvk0PL/48/qiTzxIqpMu36oBH6xMp2WTPYimSRbSfnRwdBIfx4fEW2jr5ly17AmLeSfm7bZDC99+fvH9/OJrffHVQ82JJ5cUOWRSrfniXtUg/CVaHIEwyKXBuJGAt9OtTzWA1gx1Skyr1ZhbcWPyqqJjfBIavzOgvrnxIyWgNVzDM8B/gp4XP6jbvb/qzWuf/e9PzE4v1wiqCD493uENjw8EsNufoBVWnTW4ktWBhDCmcC3mZ5tj1V5uBhefLkYXIOc1jG0g/MFDeP1ACjpt20XzYAX90tLRyfKWqgupf9eQh5sXGRr8C9QUqTusgP8C+5VZtg==
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 resolves a wallet. Bind the API key to a different sandbox organisation, or to the main wallet, with `PUT /config/admin/apikey/{apiKeyId}/sandbox-org`.

## 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: eJztGmtzG7fxr2D4yc7wKcmOrWYyVUQlZSNXGou22tgaEbwDSUR3wAXAiVI1/O/dXeBe5KlSPJl+aOwP8hG3C+z7hXvoxCIzIuJOxJ3DBU+s6MKSjYzMnNSqc9iZrqRlQsWZlsqxWCTCCcs4W4v5SuubPpuuBLPC3ArDYmn5PIHXDtYCAOMqZik3N5ZJx7gNW8R9drRwgIOgfqnbQLNwpmVKs1QbwcStUM52aTOE0vDHlLAFebC5BhTHFhLgpPPEGWEzraxgkVaOS9UkTyoAtIjBE2YdSKLf6XZ0JgxHCUxALh1AXMjlmKi89HgAk3HDU1gxtnP46WFHbIJNxkwvGoc5HXjFM8QdT7NEAPDrN3y02Iv24wPxavGafzt/E72Nh2IEQBI3y7hbwbOC4+BX2Awo63aM+C2XBpXnTA66s9FKpLxz+NBx9xkCW2ekWnY28Mrd02FW0qmb7jbJZ/TAkz77oORvuWAyBqHLhQRJBz4syH+u75g2S65A2YiATOUg3YVGZYKxIE3CgvAvV0Kxe52TLv27leCxMF7TaDQyAv3kQSWl0FEpuIAKE3euOB35j1tpwA25YxItZIkqdl7sPAFhe3R43Uo9WhSaTB0vhccGsmjg9Nmp4LeC1j1DTOeukMPWBv3P6rOa1tkFDFuXBtMquWfrQlg8hx1A7uiUbC3dCpxtLrgBQB5FwgKuvhGqJt4WDMWOzifsRtw3Re34TfDOVlksjE7pbUAm4cilAg9sUAx+pVFt4ZwegkbALeqNP6KguQyui8AgqkeJIAZm5x+mbHC7N/CuN+BxKtWAZxKwBw/w/8/ifhJvBmGHHuwwY6g/oI8kPvtn7yKfexVMYnhnQ6Qpwh1Zk9duna+asND6pMqRdU2iz8DCHHACusbt/dFnZon7rzGuyEVl7nMIUWFbW9lAG8NpDmYn7qSFvel5LhKtlngq7GZ2zTUAITOJvqdQqliubpReq5rTYrTc8uF25RTOQ35QbOpjbXMHgvPUeaFAxF8shAGALSrBFlKwNe/F+GvBZeJV+7fp9JwdDIf9Irp5IVXxrSnaRpALGeq/RLl6UH3zVoz4QfRqvrfYHw6HI74ffzsadjZXuKXPCRY32RsO8T+KNsrhI8+yBN0JeBn8ajE6PtQOzQxGKic9dgjHhJYkZwtKBhXJnzoSedCBl4zfJ5rHH0wCP8KJU2QCuMrnGI7nIj6hbAdLIaEiohWREQ7MHp9vZHZhk4/CgF48mbDqZAphF9jvAINBMHr+q4gcvXQklSp9NYP/UZmjvMflIRK3hr+6l/Bkze9tSNeQps095FKRxKVreRK6YOHkQTNb9xs0gqY4QVo7et0m9tH8VBQlz8uum0ItX37grhuBD9omLZh76wb95ae1OW9TG14NJPegBcwtmJp5VYTseHGxr/f9FI6FkFLCQ8AU8hbCIO2FdPhqDKnC0gmjjo1Ah8RqzcCfZvT9qaemPKJeLIWdmspcOZfZw8EgrPQjnQ4Q2g7k0nDw3k3TrZ6k4dgDM4TaLtfqFKg8RWfeiQzdxtJdb71e90DeaS83iVCRjsF7rzYt3l1RtuOkbZFgp7okJRDZ1guxTnkh0C6m5H22NDrPLCoV0qhM8xQ5HRXs7jNuDDoxJZaVBrPhTcDqrKa5GbGAksdimqhAGukkVHIJZLfCXoiY5j6xFh7ciFRDZRXnXqSC3fIEMvBumIgweiv3jiu+FGixl1UYDmIlptr0jYiQngrMuiSJLFtZeBRBAqbSDDOhiuWtjHNoFJbeIUwpgUBPF9e4vbFVqd8F7tYK7Qjf5VmMbIFMJPRL3HFKg06k9mlTvSjNwtNXM0vaye/dB8U5SR1dt7EecRWJxGeTQG4fMpZeN1Yw5ewsQoWpr8VdJs19sWnoY3YOK5hteeMx6mQ0Mao3V5sNJr+ldDy5pBruueode6Siem+o9oSy09lkfPDxOLwh3VG4JKv8CxnrDAxNybj/zSyYH/iHL2UoAoY1snKwCr/fBJV7Bnj46xxMxYllSKFKiNgbFpsFnkJrUB1QlXx0TIJtwXgyPtZpysDwnY50UlaRBX1QEFCKgJYNdgomu9CoPdpGWpvDPhYSCRV/Fa2Qi1dcLYM3F/ut6Nwnt/VgtG0TH0prtBaflr7p3+5vYyMFpYgKGg7ZLHSM14g961a/QxSD8hpr0Vl9/2se3eALiP+i6ltuqSIKxHVbsOD0GFzr2RvWef2s/hBX3VWexhqamPeTh9bXhSxaQarHa1L6k1DE7NNAWLE9DRcmOq1gSA66NQAp+QgM9bM7hO9aY+3IoMdnQm9x+wTsNtMNs66bKlj4E1CF0h6H3DXBZ8IGCSC0j5YQSt9xcyNclvBIPDteAhqN5wLe85JhfaYAsuPOJ0OfaHA6iNTgODBKtM0hePKlET7Zgki0if+4rFejvY+/r6tTr8tTr/2pKCmfWUJbVR0+1zoRXO2cTkOWGQ7XZt3WCgtHlF5m4AYSM4yv+Mt27WkGCdTPRYo6rhCuz08ae+goT0LlgNOHyU9Y7fYu5FJxB7zOymHSggkerSpqHusPKPNgfRYB49Db46BNqtDCVVz6PrnLrKZEBIUqkVAOVbmlmUf9HXDiZdDSpn6BxHeKRIryvhOZnl6wCKvChS8XQ0UbCncGDQZRUrXGT/ck02OG4I8Zely3AiqvZ/+Cf71373rj8XS1OkzTQ2t/mWHTlXL3SJ3rU19dETTbCR7UbHn2hnuve8M3veHb6Wh4OBodjvZ+6YAdX7V1BeXUfWu4XtYf3vJnoT2E40MD7yUO0tp0G9OLYryxM1PwntScIP8MhIeZF0gaAQ6Go981W6kfLYzR5hg6KBQHPo9rp7XMOJodQoVd6ZzKMpo1leI9GA43Ldu32EmlkR/AtKTKcsfKOwAUx65APiiczWoj/00JZVs0B39i0bwXVucGfILua3SuYm+ijYnKilN8LYya5odo09h+KTYZU7vVuM2p7pd25P3qd475/r/kPYHzDN1x+bs6OmZLRj5v5Ua6e5piHtGcHR6v8LboB7qEOAKDphXkmi/x7qscKsISULDSeGfm1UATT0To1Ib5QVmDh/Ima0MDTqSr7S5tLFIdyAa4HCdL5Rwohnc9nsm+H//0pW652To3Os4jsqhHtnlqhwtgFUT/GLr1r7cJuarkeYFm5a2hkGpVmfmFR8bhRyGCFGPerbltcVNT3QGVQ8GQWHxKnDX2KcuF4i4BasuFvIPs5q9fPI1sxl6Ae/qiwxkuE5JBBrXWyy4T/WV/a9tDFhC/w5sLFAfeDX0/oyRct5+Hjr/S+pGSJPDx98vpLm+16y4wb2sL8vxOgWZMwQ0iWClB8mWqNQihU/op6o0ynVQLXQQFHlFQAO+XCQ3hskwb99dKn6VK5E/VUtMQ6ja0xU2JhLXSLTSUWCdDt5mhnzC6lE2L6r5Qmu+WaX7rqyhM3uy47FYsm4T+ir0Ivf1Lam3bEc9rDQQgFK34y3LEQCU/xFC0KqH8Xb4PyF60VItSo9al1ti32KEeC7MNFtXIyy1ZjAMwbmLbI34lyIEtEr22Xp1B0kTt5f4x+3jMXoA9gIlNTqY/sotxD37Bqj9tcnHGRm+Go/3eK5aOdTRIx6e1M0PdRSNDCO4CalTUauFMYLsg173+cEd16/W6z+l1H1geBFw7OJ0cn/zj4qSHOJtqRlupE4UV6ygvtQdbYyTzaofq7aC/36fbhkxbl3JVo8d/U1Ckr20PqCWrP+l3GMFfsTkZQI8HAXIT9PYQEsunzu2en1RCaoGHSpSH1YcSEIhXIHuEfniYcys+mGSzwWXo0w1lONAZN+QmPgOVLWLbVzF1xbx4H+qEl+wZH320MlTkAYVJgKI2/ILHG0wTte89NniREKLb7yPy67cdX7/t+Pptx9dvO/6H33a0Rjof0Xa+8ChjHlbeHuaIlFJ7t9Osbertxvjk9GR6grexob6sausbqq3DA4bN1nC7XWZ7KvAv0tSK8h26Ehjr9yW4f/MoQlmYemgUCU4k/wNsH7pc
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 global configuration, a credential definition or a presentation definition."
sidebar_label: "Deploy digital wallet"
hide_title: true
hide_table_of_contents: true
api: eJztWVtvG7cS/ivEPiWArJvtNBGK4tiW06M2qI3ITh6SAOLuzkqsd5dbkitFR/B/PzMk96KVnPigPU8tgtgSb3P7ZuYjvQti0JEShREyDybBFIpUbjUzK2A3s+nZhysWi6UwPGUbnqZgWCKVnZVqyXOhOW3sszsc0aDWIgKmYCm0AaUP1rGNMCt3dgH5bFqdGfLoAfKYcfyvwJQqd3txrJAiN5rJxA7ksGGxVTGD3PTZFe7HCYELClBOhswj6LEQUFFgW1mySAE3wDhbpjJEQyKZJ2JZuuU9HMcFMR4ncC6GROTCnaNwqlCgccqd3Ez2P+ef87uudVmpDVvxNeopW2qyLaCqswSPaw3CV3SSdlJawwr+KAGPcSaheqblWZ7rDfnVuvHfd3e37Gw4tM5HU3EHim38YFacjsvkGvSejB7T0jmG57k0fsYK8vHgKBG9FDMjMugHvaA+dRYjSJwDHVSmDh0f7UYb1RjXeysuZbwNJrsOxm7sB3S2BohrPD3AlmUYJ0Vh8OF26vTZ3IGDQVaYLQvxVGYkI03b3sn4A9iBljvJU7J0FkHc96oJDHgwSXiqoUfWGFxKevKiSEVkDR38rknZXaCjFWScPpltAai+DH+HyOBJhSK3GAGaZiO1LYxcKl6sRDQHElBv0UaJfIlb9h1Bq1yY2maUGuP1HK/cEe4TAWns0OK8up+L9jDatOZpiXDN0y3brCBnApEq0xj35cCiFVc8QikExwzzpmdTEdcg+GOLKxsru5OQsxRraALiz1YYEQI/iXNqoedRHUo/l6RuIdcOYJjpEzQQChJEQUL7UrnUVrb/vka4E5gpSEqmFED4yrMiJbcO41Ey5qfhWXQev4IfktfDNyM+Dk+js/gcXiU/BI+Pj631R2P0rEMeCTa6kLl2sR4Ph4ewbrvdIdBGt651nTra1Dq/rIXaGAwXqSZr/yJ08iUeMnfaXfuq+n2AXnIN7P79uwp5riPMrO7OqrMPt7XRftFeY9iL18qYQk8GA16IvsAoYAUXcrAeD9pbBq/G8RsYhm/gPBzx18PhcBQPk9fhaODlBBiNpmLfJAmo51t0xJirpvrbw+qu8/9QftBofiJJGlnjQf6MgiETs+FY66u08KbUcLNh3td71B/2hyRFYxcrdUsImghL1KArZdoA0e2pxLjT2QXTZRSB1kmZVs2DpxuOtEGDceXGb8QqPfW62a7TadV+F1UTzRbjhdU8L7Ng8mn8pWXEuFZ/btT33fRtA6j+GPhaFdCntKn0bisVVINBW7tmFNVMIUaf/sYz+L6etKoOoaBFYWkwiu6MpjM4teu+MMVi4jiWOpJk1yUlPtbmy1RGD1jZRc584ms2yxPFcV8ZYeGBRl9Mi/8pdw61PZ4sqzLsQ6hFH8pBI202fQYKZzZNsI+oSqh3Sw5mI9XDfp+LJVCbooble43rQFSpfFwrYrkYLvaUHaJeYs8vt0quRQzPQNq+P5Etuo0udCupfTYcSUvxsy8h5Jam9L/HuD6nEvwMVRuzUGhKgcNKiyMfAceEvUXhD0mpDEkX2rG3I2aHUmJPzw/EfyQisEC7YdE7ZPmCGrxvc7VLKBJIOHFSIwdwEtk90ml2YQxoR7E1VZd9kn8QPkvbFn12rx3VKIuY6H37AuAQUHC6bEis5zxM3dqIFzwUqTDbPb/YI12Xr8jhp+Mt8+nW05TxutS2i9ZeZWinXSspnsThEYQcCdsXS1RWwPEL1Xn6duaYyrNZRNsBoJRUVzImfe3naQsDWAC/zTia3cdyvXY9Kvh45PgjCdCg+JIjN80LZIgF8tYMDLVRR9MOKVkXmWX+kMtNfgS2PEWmileLFe/el566oVU73E3NU/bOnVZBgpXbUbxu1e7GavQ3jtV9zku8qynxH4gPXHP+t4bxDOUpd2FWayKoJKbjI2JIEJUKSxsavQsuCvEr0Mcvj71dcAnIGtUFOtiOkNV8qS2j8bcSX5BfVLT+6iUK8INNhekFqOZK0r2pwO5G3uJ0ZkBE2D0LDPw958TlwYByQ1BEnfLaatfla5n0tuG6UqUtBhHj3Mke5w7IoP0DUMEYSyYl8RPHfO+EOfoD4/PUdu2mu4p8aZw+J+w5yFSur2PP3QCVdzrTRg2/5ZYkBhce9hbLB5324nZmHwEoOajtRK0HN3/vdo1/sXfOgjkx7k0qJGoCifhKd3h6O1o4HdmCvUDS5Hoj1iXsjOSDgkfwssegv+x3jp0wv/HHrSwVueMElfsJCRXirw2yXRDab2+lyjgmbPDLx7tD2+wtAls0FkrMAa0r9dxJXmfMEbanBKs9aBPe8hS7IaiTmeIWUE5QaXjfPEZd/9m3ANuiZVWLeGRrERYdQWjRZVFIZf7VIKQOckP3utBqo7Ljn3pTxaKoL0WSLMCYCfqd1Y+T1a3WPTbQPeEDKOTPlvs0d1y8AyAB4zly5hf+BvyydZ/vbrxtv3/WxeH2JWlkZCRT7a9RhFNHtLTvqi5Y9g5oOV/PPji5l6U1SdjWTyJRS71SWwwaXMZVrE+svQL9wJJUbvzbp/e01fbj6RX7cMVeIMIQtLPru7dsPj3BbzjqpM3mN2z0ejg6PTln2VRGg2z6rv3om1iQ2ucW7CmQawuQKj0xG9CvY7xEd0O32Wz63E730eSB36sH72ZX17/Nr0/G7uJthNmn/NZZsYzKOnot9jgJxsPxWf+0P6K9VGUznrf0cZfNzmtSN7VarfKfJ/1/nvSPPen7SkkvIYMi5diaHj2+d76pfwrWY/cCib4lhO01dvdXAWrt2AXpqksbdruQa7hX6eMjDaPdynIQhDdXtqI4RlI1QeICD9QrgyuH15M7UouWY2uzrbND86h1ux3UPQrzzbVtvnJ7M6cOFPo/SWSW0gWKb+hvAvhzEnzGf9YqW7csjaTxXZDyfFnidRDXuHOps3Df55oe/2B7vP9AllVT+balZbfdO2PoJ5l2dMuPVC+w6/5UL3czT26oG6RbTbGly+F/AdItzl8=
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 global configuration, a credential definition or a presentation definition.

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 backend refused the registration.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 Qualified Trust Service Provider (QTSP) credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-configure-qtsp-credential

---
id: config-digital-wallet-open-id-configure-qtsp-credential
title: "Configure Qualified Trust Service Provider (QTSP) credential"
description: "Selects the Qualified Trust Service Provider (QTSP) signing credential that the wallet uses for remote qualified electronic signatures. Configure and enable the QTSP vault before you call this operation. The service returns an empty body."
sidebar_label: "Configure Qualified Trust Service Provider (QTSP) credential"
hide_title: true
hide_table_of_contents: true
api: eJztWWtvG7sR/SvEfrIBvWwnbWoEQR0rt1WbXjuVkxRIAojapWRer8gNuStZFfTfe2a42ock595+KQpcw4C8WpLDmTNnHqQ2UaJ87HSWa2uiy2isUhXnXuT3SnwoZKpnWiXizhU+F2PlljpW4tbZpU6UEycf7sa3p8LrudFmLmKnEmVyLVMslznLWMk0VbkovPJiZp1wamFzJb5Xonk/Z42OWY7MC6d8T1xbM9NzPAtpMMnIaaqCUthSLGWR5mKqIFGJtS1EjG0wrL2wmXKSjOmJO0z3pc5OQbDxkCbUIsvXYmqTde+r+Wqas3wOgV5MoK671WbCmxu1hK1emcQLjV1l/ADZFm+CRp5NgCkN+0fDDtnM407JBJNiMiYoXunI8nl88j33Wa+WMEom0C7qRNXcUQL3xAzLUM91LtPPjO1NpjBW4fUBcq4rMRDg1PdC+fwt7I0uN3vuZjSbfrNCxrleSviI3EX6WzeXRvsAailQY0l0mbtCdUinHMtJuMyyVMc8s/+Lpx02kY/v1ULSU77OFPa001+AFwRljozLtfI02rS9MdvnDtzC7IU275WZ5/fR5UVnz4zRUNhZTY9DQvbEx9IbqQaT98xusIYQmKvAXbmUOmXijYaeLFePcpGlpNVrcle3ltDVyZto24lK4vy3+t+Ofg4hU5jUxg/+h6YcUYS27WbaQIdt00Ff2qjW+n3bbmlmJp1cqFw5eODLPjdu+IGxMxocEpolIWrdDm0P/k7tY4sihCBRP9AHEVkSsCc+3yvD0UqxFMbuwX3lOmUclaFamABA7RRt+AUz7THf7W6ge3JUh05AU/uOkHOpjW8lI16O4aPac8TbvLVugcfW4r2gEO+VXAZ6BYOELfIdDnsCDnIOhb9voiGsSdditQNLFpAA3GOKyZXO74VE5pMOE2UcK4+19kGZBrxHVhhxdTsSD2rdhjqXD8o/7cmZswseLRczOCAkJ8mGxpwO4bZyny5N5YwMq+UTDppq5oBiuYDqSSXYgMntxzvRX573QwLsywTh1JeZxur+Bv//rtajZNsvJXQhYSLIf9CPEZ/8qzsupsEFyK2gBu+YqMwpwilhNgXvNu1qgEXs06Yg0y1Dn4FhOSyBr0l82PrGzUn+CpsLPavpPrUwI4j1NQeOGbygWqsekac64XmqUosUgF0hzR3StZxExqR2rZKeuDLIJA/GrkwjaDvknnYMH3fOLng4DnZCO7xVWwLPC9oFUESiZzPlMGFPS3BhAa6FKKZvM6TW4Nq/3t3diheDAeU1ypxRAAnfyCP43oa2VYBmyN2oQAclpky622am/MOrV39SZ/JF/HJ6PrsYDAZn8iL549kg2n4jkT6zxodKdD44+/VKGe8KLjJQwXE4K9J0HSizE8ddBiHJPQdZWDIA8in/wmwufb+1gjYzu3LOumubKKoH9Dxs6AuTflxt69U1ahpazBn5CjUouD0i/kh5q4F+i3ZGmwxRUZWXaBvqTRvSgBQXhwoootwSvWHS2e/2ysEa944oG5RW37Wbx+w/hvjZ7xjxj4Zqg3X63yo5gObl75qMI+zn0O1wukdu4232MMIi7uN1vuZ+6YrrDh6/bTub6C0X5auCOjy8IavlnBqrqOzXRWjYxQm37MMXn65PsQEkiH9II+dqQbBjGbS8t9TtZ9YzWJJERo3ylwSB3VDP+sDS6KSPWthdVJL61BlGpDHZc6zBG+IsVppLraFLKfnmeeYv+/0EY13U1Z6eO2nynrYR2bjXtjqbFDFn+CfE/JqEMSCi9vaJ5T4M7yvyrfbDmOgYWLTzRkWH0BY8VVauykhgekf7dKg6nrqXqs6UyE+F2jWCk5acya6H29VktBcz/YgiEdqYoKOYiBNDx2ASkDuUQsYgk7E67QjVm/f2xF6KcuFr6gAIDuqx3kx6VOKavNtEoTX8ybqFRAxHf/t8d2hbo21EWHi/Uy9IKnWm5q2lhKgQ5BxAGIbNoiq+yW98BKFs8c/64PluF4/7x7zjB6nGOerwgEPunNldpsJplTMIOmwiji+yzLr8zzVZKn/rv9Sv2ixrEnQPqmoRQOFLD48mJ7ZkDNyn6T/FWsCnZESIbj7/fFIOnRIfIa8bp82R94U0aClPbjgNjE65uTq+8BbNRLVFlTpuT0mj3MY29cRKVD2ibLgo8WX3FfzGrZnGlqoj7m1adnJL2mEtykzSOgwXnumYY5p0ie+yvRo4iFlqVz5wpUSatf18cS0+XYsTkA38Hb27+0mMh118w9uw22h8I85eDc4uui/FYmjj/mL4vlm3Z8xXPmSj4ii0TuTVXaQiMIDreW9w4LrVatWTPNyDyf1yre+/H12/+3n8rktr4NRc52mLAwxWYuOi8h5EU5oMbj8fnL/oXfTOaC0lYWTVhj713dRvvSGLmxcySbt2VfX2+e7t/+3urcxqdOfQz1Kc4fmKhwi4KYvyl2h5HnXKaznybaswh+s7lGY8tIszXnB5RiW7pyIPQZvNVHr10aXbLb1G7nTcWoCX0nEqCI3GrpBxPccBCwP1SehJbj1f5jxf5jxf5jxf5vwPL3OOZs8H6tAPr3S4pcYAHxHCnOuQu7p3JKaecXAmrVdcsRt/OLd5urq9GVNvPC1/GFnw+TNyckVXTPi8jL7ij3M4t1F85qX3myiVZl4glWNOkEs9ryw78Pr08cCnj/KB8vVuyKwbWu4fRIIx9EmmHV3ymmIYUfKmmh5GnlxQte5hNvmCfgL4D9Bc4lU=
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"}>Configure Qualified Trust Service Provider (QTSP) credential</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management/qtsp"}></MethodEndpoint>



Selects the Qualified Trust Service Provider (QTSP) signing credential that the wallet uses for remote qualified electronic signatures. Configure and enable the QTSP vault before you call this operation. The service returns an empty body.

The service stores `userPin` and never sends it back. To see the selected credential ID, use the read secure vault operation and read `qtsp.credentialId`.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

QTSP credential to activate for the organisation.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialId"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters`"} schema={{"type":"string","minLength":3,"description":"ID of the QTSP signing credential. Use the list QTSP credentials operation to get the available IDs.","example":"<qtsp-credential-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"userPin"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 3 characters`"} schema={{"type":"string","minLength":3,"description":"PIN that unlocks the QTSP signing credential.","example":"<qtsp-user-pin>"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

QTSP credential configured 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 not valid, the QTSP vault is not configured, or the credential ID is not known.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 secure vault
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-configure-secure-vault

---
id: config-digital-wallet-open-id-configure-secure-vault
title: "Configure secure vault"
description: "Configures the secure vaults that hold the cryptographic keys for OID4VCI and OpenID4VP operations. The iGrant.io vault must stay enabled. If you enable the Hashicorp vault, you must give the username, the password, the address and the namespace. If you enable the QTSP vault, you must give the CSC URL, the client ID, the client secret and the user ID."
sidebar_label: "Configure secure vault"
hide_title: true
hide_table_of_contents: true
api: eJztWutvG7kR/1eI/WQDettpUyMI6si5nq7p2RfZSYEkgKhdSuJ5tdyQXMmq4f+9M0PuU+vHpXC/nJEg2Qc5nPf8Zla3QSRMqGVqpUqCk2CskoVcZloYZleCGRHCNdvwLLb4hFu2UnFE70K9S61aap6uZMiuxc6whdLsfHJ2/Gk8YTyJ2HkqEry9YCoVmuMZpscuYbP8h+aJ7UnlaLN1Ziwzlu+YSPg8FlGPTRZspzJ/Tyf+zA0cpXTqNnXoPe1cyo1bkhmhE74WHbpLuTFbpSN3x6MI5DLEGd7jOpPyULSd9dvl9OL+Y8bTMbv6+MHRDWMpEssmZ7VbUJ0WtjgMGYMlva/J12Qq/MNFFscs9Con9TD4KzZC71jI49jpCnZuZChQu1uuIwNr4h3tn3llzdgi5kumFox7fTpTcVMsOWELHhsx6zCjmLQMzGFyI1ulRQT2FBEwLmEZUiIKRAy4UGBfkXqz15bxXEnFAsdAbsavSdAJCutPIvAxJ/CZXErL488gprDkKFHhfFNyu09ICHZr8T0Txr5T0S44uW047LTioQ1VWsV4mqKqFDGm9JIn0tDLnqcrQZrgxOpMdJAvC5LhGbhPhrSy/7vBg24DE67EmuOV3aUCjlbz30WIDDY5sqiYFo7A99/zcOVfoXV40rBh3eLulamolUy/XYnE+Q9aXYKRUYAZypRq1LWVwiCjqzxgnCofZb0MsE8t+sToFjcWAyzGeCfH4Uuxf64XqXLgXKlY8KRVWWAeJwBe3R/ueIy44es0BoLkzHedgN5c+aCvnGeslsly7zhcSXFPwjTF5RkcC67tDN9jH72DOIWXhqppvGDJ8dLFQA9yzi58Anqcs3zlczD2xnGWZ8O3BXunLiM+zt07SBZF/qTkIPaYRKcV+g8zt7I2NSf9vrOxf94L1brg8tc8Tz/OZ7GUyaTJ4B/mjEdrmQR3d9VM8aXw7W/wXC6xikn1xPAqi96aJxA4UVuSwAwADLk3cMHjLYfSykOLxQfLCZajkCeJsiyCdIbhIu1zBWGjULv85DMylBQJVUC64mmwqs1clakpEsk+pMXv1qSPK++3jMdyIUFplxpr8dTnyAutNjKCsD7Akn3YkrO0WCsr2PeCgIjhAK0SgC1GLhNuPd7RKluuXH2PVRaxaf6SQWUyCjSbrdkB1P5DdnoxeS6Nl8ijNeOFJrzS8RNDFjBKHq4IWXxd+eEYhbOrEYr3GKUO8UyekOXGOVQiw5Ck/2tuQ+/pOg660uU2dzclAPZknjxeexa+HG3iDcvD5OyJlQr0pMVSGqi5eLC0q8JDfpAhPL5QkwlPU/lJaCMdwnlET+BA4PZs4zag1wK1HgNO2WwznJHqcNGwN+gd9waUq2abUfli1BvBq0Ed42QIQ2k/yYGZJFIMk5txMBnkgaiNIxInydaYPjZDuNmMgm+1+jt8MFlH83c8vBbRE5P1Gbd8jjE0p12PpmrEvw6pUSskHULbErxlkSf2XDkjamO2JX3cq57GiwZwbFY6n7NhG25MuYayCz4KAn1p4vNzuuDQylwlEqoGk9Q9gEV1npkMOMpc3dTwufcuch1yAV9yeuxz7iWle6wEhwLQ8R2rcyudJc4aRe+Rm4Rg/o3NT0c0GLXy0HE9kDQdxpdcJsZWTZq3SK3co+ujC1f3reGytrnRkbAPgvv20gnEVGZzPTQIUBtZjSINO0xVG5VOAZVVyWbCJRLO5oJrWMjDEFGdVdciqai3ZUdC8Q/uXVe15dd5J9mmi4VWa3rrN5NyoLIqV3QLjqnNBLP5c7q4FJtgtBu/x0Bz6TtpXOzbvFYmSIDZxdUl629GfRfFfQJ4fZ5K2N2/hf//KXaT6K7vKXSBAqRTsB/wRxqf/bs7zebOBBOXain6RKoF6ilyvQVZtypXRVnofTLJUHRFqk/Bw6B9noOtkbw7+lwvkf4WDq/Bq7kCMRxZU/pAm8A0rxA3UDs67nouYpUs8VSgpvfd1S9CYWK1wwHMacKy5DpR26QStB00Tz2G242TBw/FQU60Q0fVKdA6x51TCqDaxQIqHhTlOpfgC2vwNRfFeIf405n258vLC3Y8GGDOk5h3nJLgzjWGQV21te6fUmNnv7/3dfCuWmP+8vr138SQH4ev5qPF0WAwGPKj6K/DQXD3DUmaFICiS+yjwfCJ0wpMPxkFIc6DdijCD48i6sXFVOYo5WKuNd+hZuA0zP/5/KPO6uSs6PSq4z9IGWDRbT7f8Qm6mcouaVeM6R6KOx7ky3uiys4mHxGhyaxYV9tQCeIvyXwP6G9y1mMzjztaWpUOm43Kl3uzw9lR+bI67Jsdl8/vL6sOhww7o85R5/hb1UW+DKkswiMfpyAW3oFzooBPtmytTmut9FhFAo/G67OKVsDxHvaCcnebggvGgcG7FvItuLAMh3ccUnmSQu4qQEDgpa8brto1zlW0yxMDOIn049nmSBhW+PYWFoBBeOuQTyLUgl4E+LEEr5paH/6JtX6VYBVXWv5HRHuqefWndshJ4geZbmzF6JiGjmATZVBpd4RsTwkhwCUE/G3wjuDTKSiYnqDUfIkQOPCjbeZm2+wg/wwyPoQDgAL7F41/1qh22AZcrhQOxlNlSFkcSQYVoBI5gl2HPPqgy0RGfUAt3XVJCZlFUdpQ+JlYKy8prMtwflA09RG86wL46TmMDwEYoHiN8aRWURZSxN1D5jEKU9AOWOu+7ca9bjLyrTTBFD3ROVBuiLKkuQf31P5THwTk2Xs1pYCljYa/rGG+DM5qdGY50M6BE2DAhbzJ+/SZ45HN2EGC0yckYDXgFdIBjigPO0z0lr0G2RPmN75BmIbqQCD8Fpp58Maqy90GDr//pPSaQ/gGv3y+3Jetgu3pa1jOnqPkeUaEXWOCFRqk8KeulDYERWij3ajdxkTxsfxC8z4PxbavD0Wz6yFXY3pfnaDvDdD3p9jNIfYDo+T9SXI+3W0Z4hZc0uCynE82uc8ncQ+Ox6rTsf1hVXNW1T42KqdGzSnO3hCHhiAts44672g3mSxUnv956BZBh4nymCxNlbZ/L+OwCKWiSO8FcDX27517p25Ya6CY5zWbSfwfM5j/AOqCzeVMQmIgHHQKNOsYVz4+TozJeAIt1YH/5HxY+ebc3HgBLlIcUSTki0PkyKpQxcYPczAb5J/dHKZ1IUGtiYQjRYc+gbtOZoMn7JjPz7Vvo5mhSLewDD/adkleCXpgi1htjQtDr2ni9vPRmH0aswOIY0gNk/eXP7HpWRfu4Kk7bTI9Z8PXg+FR9xVbn6mwvz77UDkTqUAqMIiCoI4L6ETQqnkSBL8HvY56gz3TbbfbHqfXPRC57/ea/ofJ+P2v0/dd3ANGtdLGNR8gZUUqzArrYaAVrjgajI57Rz1ySCxtUKsq/BQfe2s/MmhmsAo+efltwstvE57htwm+nuFIsJ/G3NWEzH1hcUjsC06aO/5nC+igNTTmft4AeAwuGogMwMsKIR1QuL3FPhLKxd0dPoZyqQlIYmHS0nXhCCtz7EIQznc/RcG5NzJehqwvQ9aXIevLkPX/OGRtTZvX2JTtj1qpi4IX1BW6NWOXu7qXSKZcsTeBKHeckhkfXFvtpS/Op9gOzf2PxtY0bQg03+LoF/49Cb7CH0reVPppwoHPb4OYJ8sMcjiscXQRLnPfdJUN5zU1nP4C83X+KtlVuGz2nk4Y/BdFa93yBmMYouRtsdy9uXdD0a251WgLnEH+F3c8u7w=
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"}>Configure secure vault</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/key-management"}></MethodEndpoint>



Configures the secure vaults that hold the cryptographic keys for OID4VCI and OpenID4VP operations. The iGrant.io vault must stay enabled. If you enable the Hashicorp vault, you must give the username, the password, the address and the namespace. If you enable the QTSP vault, you must give the CSC URL, the client ID, the client secret and the user ID.

Send the full configuration on every call. The service forwards only the `enabled` flag of a vault that has `enabled: false`, so it erases the stored credentials of that vault. To keep the credentials of a vault, keep the vault 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"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

Secure vault configuration to apply to the 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"}>hashicorpVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Hashicorp Vault configuration for external key storage.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the Hashicorp vault.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"vaultUsername"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User name for Hashicorp Vault authentication. Required when `enabled` is `true`.","example":"vault-user"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultPassword"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Password for Hashicorp Vault authentication. Required when `enabled` is `true`.","example":"<vault-password>"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the Hashicorp Vault server. Required when `enabled` is `true`.","example":"https://vault.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultNamespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace in Hashicorp Vault. Required when `enabled` is `true`.","example":"admin"}}></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"}>igrantioVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

iGrant.io managed vault configuration. This vault is always active and you cannot disable it.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the iGrant.io vault. The request fails if you send `false`.","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"}>qtsp</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Qualified Trust Service Provider (QTSP) configuration for remote qualified electronic signatures through the Cloud Signature Consortium (CSC) API.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the QTSP vault.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cscUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC service. Required when `enabled` is `true`.","example":"https://csc.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client ID for QTSP authentication. Required when `enabled` is `true`.","example":"<qtsp-client-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client secret for QTSP authentication. Required when `enabled` is `true`.","example":"<qtsp-client-secret>"}}></SchemaItem><SchemaItem collapsible={false} name={"userID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID registered with the QTSP. Required when `enabled` is `true`.","example":"<qtsp-user-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"cscApiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"CSC API version to use. Use `v1` for CSC 1.0.4.0 and `v2` for CSC 2.2.0.0. The service uses `v1` when you do not send this field.","enum":["v1","v2"],"example":"v1"}}></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"}>dbBackedVault</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Database backed vault configuration. This vault keeps the keys in the wallet database.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the database backed vault.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Secure vault configured 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={"secureVault"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`]"} schema={{"type":"array","nullable":true,"description":"IDs of the vaults that are now enabled for the organisation. The value is `null` when no vault is enabled.","items":{"type":"integer","description":"Secure vault ID. `1` for the iGrant.io vault, `2` for the Hashicorp vault, `3` for the QTSP vault, `4` for the database backed vault.","enum":[1,2,3,4]},"example":[1]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"secureVault\": [\n    1\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is not valid, the iGrant.io vault is disabled, or a vault configuration is incomplete.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 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: "Creates a new ECDSA P-256 key in a secure vault. The wallet uses the key to sign OID4VCI credentials and OpenID4VP responses. The vault sets the key type, the curve and the algorithm, so there is no parameter for them."
sidebar_label: "Create key"
hide_title: true
hide_table_of_contents: true
api: eJztWVtvGzcW/ivEPMWA7pYTxwiCdWS1VZLW6sqJu0gMiJqhZMYjckrOWFYF/feec8i5SXKdBXb7UseAPTMkz+U7d2YTRMKGRiap1Co4CwZG8FRYxpkSKzYcXEzO2bjZO3nJ7sSaSQULVoSZEeyeZ3HaYle3gq14HIuUZRYOpvCOW1PNrFwodjm66H8ejFhoRCRUKnkMxFXELhOhcGnMjLCJVnDWESO6wCSt0FonokFvwPle0Hl84/FCG5neLhvMavwCYknLlGYJN3wpUmHYXBtcWba+qq9qqPgsFnTWsZkJWBdsrTMUEDQH/byiMoUjQSPQiTAc0RlFgE+o1VwuLuRCpjy+Jr1Jk8gB90Gs4YgRv2fCpu90tA7ONjsIfybG6S0HJVNg7tREtIFxi00EKMcVE8skXTM9+ybCFMEEcGmj/NFwlbak9gbw7CTAG5zNAV3RQCFTwBp58ySJZUjyt79ZFGAT2BDw4PiEwIJIjgtQSgxqm0phcZUYXNGWYqsEygthYG9dq9EF0/MKsLv6kW7T7hTtc0CNBpv2irWfuL2VoTZJsXZcrP16NRl7FugF036xEvGUzzigNOPhnYhy//wEX5AvuAFuRndQ2ix5THYmo4MGzvWsMPcyFKUj70jJVrdCkbNEGqigl5InggRzKeIIjSFUtgzOvnQbvcZxo3+DOM3xbHDWhcUHvkxiwLG7pX+AeO6ogPiXXVe5pAcegxZKgksxSSEEvEyOtgUUZvoB1FtwJS0pk7uLc30Qzvtji13n8peC3woeCeOiK9ffZMrpX/g+BgTFH3rWQ5pzVyB7dFCGhvMAaRuML7hUNqUDPlPQcXSQQ9KjXRHc6rklPNYOi9qZFvso+L0LEKcQ01ktbCoEKBNUzQ0+ENkqGkyreF0am2dAAXAPMT+sIN9AkpgJbmAjD0Nh4ay+E6oC74ETip2PR+hzdahTfud97SAWc6OXtOoPEziQVn1cFRKD/2o0m+fTJN8GbX3GPmigmfRp1KfrR4UgBabjT1esfd9ruwzY5tFSqjZPJJxub+AvpL5RtG17Ck2gAKEJ9gP5CPHpb81JNnMmGEVl2IrECMQpIm9y1q3qVQELvU+qDFXXBH0CHgb5YQa2RvKO9aVZIP0VMGdyXrr7TIMajqwtfeCQwssM3E48SAu06XkmYq0WyBWomX139ZtQmVivRdRi54pl6k7plaoEbQPNU4/hw8bJg4fiICfaIFZ1CrTPSedAYZGcz6EOqnRHSvCFJfiai2J8m3MZO9P+dHU1Zv1OB9OXxLzjQII3tAi816E9VHH2SopNjVSLYFvJecHL09PXosv74cmsNz/udDpdfhy96naC7Q2S9F0AEul1uvuF80OerzHlZBR48yyO1yj2/6ji3aEP72uxW+wezcZ5FQ+qah/Pe/x1N+y/mp1GffFyzjvhSfRKdE9nr3t9wAFB+ra6OyRdne04m4FmFK51ftDuSIOh/n5y+Qu7FjOGWL14f/3hCIvAklObwKNIunoyriidmkzswZCunwbhg2/Mql1b6LtHEce4L/T9Goho8xYNdsYZtWnT4WBaR2o4QCxCc/8092GdQ2mKqjhFHXcdLG2tc6QFZPrwNMvfIP9oE0mFSd0bYEfRREN/1EBLYCfysp+ZuGKAku2bYrn50CypvkVJvgP6//xfJFnvSnInvyMW0A320fcmdiUFsjoHc1NwTf/72IAu/2kxJlAUeYpzSTEU5K2/6z13RovpcAKW3/W/CXkDNWZlivvi04KL0hta9WUE5MI3yJ0o4XcnoSptYYw2Ax0JlASfLyp6QV7864RVnj7UoheagYDbA+QPoFqC8Y5Dp6ESKK1Fjxr4prUOfYksEsurFviAhJLlTeDW/ZLrIMBW1DDvQtn9B0P5SWHnCO77h4j2oDn5R3vZCPgZqF3UDELFJTY7GMEhupyQWL9gmjqnrhQeb7aNTfCOWvZzAJi+oNZ8gWNX4Md55uZ59iK/mxgcAQNMcD9zxRdiibDDMZDyVuNlQKItgcWRZFBpjiNHsOm63TZgqWTUhjTSXBaU8NUGKDHqc2j8uxBL7dWFfZCisTVL08SetdsRrDWh627JhR9RA9Rxp2EwOspC6v8eIfMUhQlABCZ77Lh1y7uC3JR2mKA7Oi/KrVG4gxsaHms6z30kkHvv5ftiHionrWKMd+XH18Vpjc40n/Dyjh2Gj7l8gI7SDTlORjZlLyBRuWY5NdAoEwYJD8VRg4nWorVD9oz5g29wPkA4cAJ7C+UFXLLqd5vADY4/UCkGPd5fX+3rVhkqISyszcVzlLzMWNtrQrACQcoBiKFjFhTxjXYLMEwwW/y7vKUa5vFYu/TpbtE0c51nHR5S1oH0ItEJbJYk2qT/Kg1f2K64N9nzmKqz7ahdXrZA9rmHngJvIUONgoEpJP7FuHG6euu6SKVK/1kYaEHofm9QuWscWZtxBcPjC38TeVS5ftw9OIYppGBRpIHxEUqU6lDHdEcJZQzdT9BlovVzlrMBDWESWIoGu9Wxn9nukcOa+axQuwrNLLlWCtu4iWyT9JWAA5vHemWd3T3SJO318YB9HmBzfwW+OBpe/cAmF014g6+O22hyybqnne5x84QtL3TYXl58rPD0baDF2gvVQ8DMhVbNow6cHHDttTp7plutVi1Oyy1Que3P2vbH0WD4y2TYxDNg1FSmcc0HCKxIh1lhPSCNKc+Zvdfp9VvHrS6exYQKGbIij7tWxVDfDZNKJXy+td67tfYBj5d17STmkGG33p4bX6++BPc9NzlDxUJwazXLXXxD1YKHet1yHywWwlusf0Bos8Ep4pOJt1v8DGnFUNUFM3NDkeVqcJ7jqdRJiwvlFcKjxn2+BX2+BX2+BX2+Bf0bb0EPZk+sQQfuQqnbhAXqnt2egctdTWqjyh1741p54pzM+Jd7q4PH+HKCbePM/wfjkkazwPAV3s3C77PgK/xQDqeuhMZB/L4JYq4WGaRy2OPoYjvIfXNaNuau4PoHzNf5klpXpNzt0Z0y+BtVO3jkDcYwRMnbYrtbefRA0dW63WgLvIP5Ez9ouBw=
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>



Creates a new ECDSA P-256 key in a secure vault. The wallet uses the key to sign OID4VCI credentials and OpenID4VP responses. The vault sets the key type, the curve and the algorithm, so there is no parameter for them.

Enable the vault before you create a key in it.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Vault that stores the new key. Send an empty object to use the iGrant.io vault.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"vaultType"} required={false} schemaName={"integer"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`]"} schema={{"type":"integer","description":"ID of the vault that stores the key. `1` is the iGrant.io vault, `2` is the Hashicorp vault, `3` is the QTSP vault and `4` is the database backed vault. Use `1` or `4` for normal key creation. The service uses the iGrant.io vault when you do not send this field.","enum":[1,2,3,4],"default":1,"example":1}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Key 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={false} name={"keyId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier of the new key.","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 pair 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 vault creates 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 vault uses the P-256 curve.","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. The vault sets `ES256`.","example":"ES256"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Public key of the new key pair in JSON Web Key (JWK) format.","additionalProperties":true,"properties":{"kty":{"type":"string","description":"Key type. The vault creates elliptic curve keys, so the value is `EC`.","example":"EC"},"crv":{"type":"string","description":"Elliptic curve identifier. The vault uses the P-256 curve.","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. The vault sets `ES256`.","example":"ES256"}}}} collapsible={false} discriminator={false}></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}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The vault type is not valid, or the vault is not configured.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 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 from the secure vault. This operation needs a request body: send `{'confirm': 'DELETE'}`. The service refuses the request when the body is missing."
sidebar_label: "Delete key"
hide_title: true
hide_table_of_contents: true
api: eJztWGtvI7cV/SvEfLIBvfzYdCsEQb2Wkyi7rY1Yu1tgbUDUDCUxHpETkmNZFfTfey5JjWYkedt+KRBkYcCaB+/lvee+znCdZMKmRhZOapX0k4HIhROWcfYkVmxq9IK5uWBWpKUR7JmXueuw0VxapgthOEkxJURGEkb8Xgrr2ERnqz5EVMbG64ck1WoqzeIh6bOHZHDz4WZ085BsxqSGFJtnmQrITkuLfWmzrZ7lXCj/gBQybLmQ1ko16zyopJVU+w8z2O03mQ3kTDqef+Y5vLgtBN4Fh96LFUQKbvgCd8Ym/S/rPc8/KoltmcyEcnIqhWF66nd/8rKS1hTczXGtoAV3eIG9WwnZK42AGc6UopXYdC4WPOmvE7cqaKF1BmYnm01rf9Nbf8HzDnt1e8tVNtEvTJsZV9IGyJ1mgItNtcEaIBMh67DPhNlKlwF+/24ueCZMK8Yxwl2qgPUuijJgDSCdeHHb3cnV7KgNpJA7hKXF+IxLhYCRwNJjH8Tx+qj1eMaUdg25BS4bwqIh02EfBH8W/nlwiOnSbXHYU4AEeVDN7OKZraPBtMpXIcEILF5CA3BPuYMH0s2RzRPBDRbyNBUWsvpJqBq8RyQUu7obUrY0oXb8Keb1USyqEovCHhw5U9qIhsUoF01hi/u0aWkKbylu/JUATaTPAZ/CBNWrRngHxncfR6z7fN4NtdTl2UKqLi8kpLtr/L6nfN90o4Y2NIwZxQ/2ecTH/2zfl5MQgmE2poqlHTNRGEE4ZT6bQnTrftXAouyTqiTXtYe+QIY5eIJYk/qw9a2Zkf4lNmdyukv3iYYbQa3d5cAxhxcl0k68SAvd/noicq1mtCu0mcN0jYvImVyvRNZhV4qV6knppaoVbYvC06zh48HZFo+vg63Slt+qqcGvC9YFUFgmp1NhsGDPSuTCArkWqpjuplzmIbQ/j0Z37LLX62wbWQBp18qa0DZ62pTn9mtNrZWIF74ocnr23du3fxVn/DJ9MzmfXvR6vTN+kf3lrJdsHoNK9Kh3aOakptkIr8OQCK7E+s986961qM6RXuvblXKkkBdFTvWIld3fLGldH1qtJ7+J1NEsMKTXSWHpbZxRh+61vmZnWNNh9yL0sGeeo4UjSOMw5sZksVAl9H6Jky95rOMVn2Ew1Bz7UlnzuNmEV7bQygZLz3uXh+ihMiNa6NWl71jTMs9Xobi28tUcFYvCrci2WCtQSPsgQSIW/x2kdZOFMdpc60yQx3Q9qBkIn78O/056FwAJK2Y+Ryu8YODmiPojQdtB/I6jnaoC/aOa/skm4NrEcBT75HBQoxqtBiHZ4yEt5sev71r7SbEt7Xom7KN99idG+6OiCaqN/JfIDqB586dOxCH2M+CEfihiAvht9jCCkKfk0q08lb3y0xmXj8Qx33nqcgWA/RPyms+sb0KBILPAkNmJ58iDy0/Xp9iAusjfueIzsSDYIQYr55rodWgunkKT0qRGE7Kgsh3mfhdoKpl1UUntRaWLbm137QnzJiHbybNjLHwgFjo6jnWlyWlYOVfYfreb4V0bPKQjZ4Yr15E6OWTUd0ZnZRoq8bia/6ThHmBRBb8ibsPrfUMedxG5p8QM+bSNS5UYgUa9NoavYk34RD+YPRVD3HFPz4xH1eiJg3Pc0DPect4thwEdm8oXjIpA+4KNbMxO0LACfXAG1MFjUPBUnLaY6GDMNdX2WRT8nhgTwUGc9Ad0OiRnPQPXSaDSP2pqkfDjl8+jQ99qNBsFYu3WvKAp2kxkt2EEqxD03YAwDJslVaVT3PyEpb7x646D3Gwrszb9q4FM8ZnqbRPiqW9C6DaSMsGWRaGN+9su+lUA5U+7R820qWfcnu+VELzUz+B+9DGdarIO8ZD0S0XU4EahcP0H4CdhQBX5JBfsGk2QMgOUjQ2tLbkCpz659RU+PPXs8rjgHThCtUXVFe5OySKnU53b+NVPOSgUydhIP0MgPDfFWAQnY3OdRyr7TDuAmsSuk9bMK63PL4dl3GS27f2VwIFNc720IfgRaW/t54tr9umanSB7kJDDm9GP7H7Qxh2eht2G97fs7G3v7KL9hi0GOu0uBh9qe5IWJKClUYxhIsCIKKrb0kOmA9fzTu8gdMvlssP96w5c7kZZ2/0wvL75x/1Nm2QQVCdd3sgBD1am07KKHlRT3wthP++dX3YuOmckW2jr0C5r9oRzi3j4kDWHTDUY/0DHNbEa6WyhW+T4Vie3Pc7rOFS+JM/nSSue5JDTjcESTnwwWnDRHC7hgcVPP5zIoBXPgSdpXK8n3IqPJt9s6DEMNX5KIg7c+NQPMwgfUbjefe28CvjJr5FrnL5+YhNidtTh7RRQtML3bNwFB6oDpQ1m+HYy/G/GfTtN+naa9O006dtp0v/xNOlolwvd7OBMqep3xLnDmuvQu9ojUrNbcfC5t5O48mH86tr6h0skdK1kEo+dFv7jLjF8SadJ+N9PHvDnx4snMv6Dkp6vk5yrWYkpgzVBM9FIHkntjtCHfh8vqGMf7fL73L5q+d65oyLfUxWjTn6oloc3rwpUbDispmjQGdK/ARjSFRc=
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 from the secure vault. This operation needs a request body: send `{"confirm": "DELETE"}`. The service refuses the request when the body is missing.


## 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"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 key ID is missing, the request body is missing, or the confirmation string is not `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>
      

---

# 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: eJzlWFtv2zgW/iuEnlrA9yRtYgwG6zrprHeLTdCk7UOngGmRstnIopak7HgC//c955CyLnYvGMzTzktikeLhuX7fOXqOhLSxUblTOovG0c1TvOLZUlrGM8YLt9JG/cFxk8VaSJZoQztxLK1lTj9KeMgEMzKWagPH3Eqy2EghM6d4ylRGK7ez6/OP0xmbNCROUeLbVG97bMrTFN5UlslM5FpljvHESUOnm3pYaTawAXcouNX5K1c6FbC44PEj2yq3Ypz07UWdSOfS0MmZAANjnSVqea2WyvH0E9wq3W0uYa+0HJWaZOK9N2h6MAUkGfnfQlr3RotdNH5ueW5y7Cx0jHXcSVCRu++Z4gqTSVF6qzStF+6EB1DdmUJ2UH8HCuH9PM9TFZOk/leLSjxHNl7JNcdfbpdLUEsvvoIkEJQbdIRT0uIu6ld7yzqjsiW8tVbZO5kt3SoaDzs/tvD7dumE9pS1xQ+slE98naeoiXidDPkoPu9eLS7PuufJQHYv49Gw+4pfyIE4W8D2VbQHPxwCMxO2Zgk3hu9AonJybU9Z2LRpRkIS5bXVWSN5QTtthDdyyxWkGqY/6u4TX4aU6aFC35JrSzccCcb6ATei4U722G+QbvTihqcFVVLw7ZayFM9DKgm2XcHVyjEIKBahFG3pOkmk6bFZwna6YEKzTDu2ROncy+7UxRb2uGoP+qEKa+7iFb0xp2SeeyGNsH2OXr26gPDEZ4vLxTAe8WEyEFfyPH4dfQHf0LlTwciKNOULlOCzu+nEe6oduu3PVhB7OLIUMCaI1CxRmXcfGQk6Nb1A5d5j94BJbI66zhkkQCp5iBTENxVMF84HpX4zW3ELjvf130zxxev4So6SYfecX1x2z8XZsHuVjOLuQL5aXPKhuIhfn0X7fb32P/uC/bLf+3Wb68z6Sh4NBsdgVLO6TNKQJiUuBcBuJw9q+ldBTAWdR/pVsHqU5qVijdD5+AIpMQtBSiXzdzKVnChHynXbKubT4oC8EC9KOS0Ja20o8bK2LGSVTN4mEJhjL3zT0jqc1Dgr6GQd3GYbavJ0y3f2oK2ETN/5nOuxSUg+khZyzae1slU5EBUicMl17nb+hTGb/x79Hs09lzNfix02H5QrWbFeSAMrCU+tLFcXWkPie7YPtRCagRCL0BmgP5vE9TlSImoiduOxZN7W8gMGtbHSeEBwKCwsYS+SO57FsjwhJAAgvHgTWonm5cRGlK0yMBpgKLI+rAFEmDsVbkW0neDhIheH35qahVuz5JmyZVsBy+2FIOl96YW6Cm+1AbzxKlhYqk6pUrnq5Sk1LIVvYdBe9xSUbSDhtXRcpZYcv9G+ZA8uSuWSp3cKLHDS+utOr97pvLbxURqkMOHv0ndeW3iCRLReBsC2dZMsBkXg6ZECLZ9yNHnajKQ9tWOrRLE3WWx2edBN2fLyT5DCD3jLO2VdeeM9wL6K5Z3RGyXIYRpjib1k2zHvPYqTTN/vfciUq3sCGKrVPuwJaAFpV5KDeIQzfDr3UPvT+FgvAUhIbULg6Pd1DSa+dH6ApdXpCnYhseWSbD9QCyi4PyH+BPFWbPSGI2vmwGE5N3wNrYiJgvXHnFJPcwQa7CwAVJToVOwCy2vIYyRTgIQQ8g5rdk5lk99uEZOibGgO7PtPD5OHNh5gG2AZcsc3NnwDeY89RIlnAFAL/dRQFfGoHcrh3ziUH7KyRKi4m665+Ftn+QzuMxmwdegs6ZqWj7CjlXFhlNtRBzDJ1b8l/iQkeSMhPw3CEa2g1Xxp0Tth6mQehtgLGjxxMH4JF/g0RyeBdiuNs2quCbdyjqKi/mbU99NrX3hBXd8n9JGTlOhb8XXr+hVz9Mt2phv7iHiTLOnctPparnWwGLnLQMsWrZzL7bjfF7DX5bnqqaXhmespHaGZTQGAxKKIay35kZgfSQCyWiJmfOO49dttRb5UobjHjPSJVAakgnW/AByAV/lY4vgBmdAebI86uMndjD3KHQ0e6FhfCL5R8x1XALF5Q86c+WvYGviKLSTMazJRT2VTNvc6sjl7ASjmxwlnAMrIBzmP5csOk71lryV2zMLBX2C4M+iOLij365xm0HrqPUcLegrNxjj616eHY9vq33FyTtMkqeclBZ1xqmoO/wcPEgzQUEMHokOJY9xoiEHAeF99OLkpS7L8BvFzE//RwP+9ifMwcP7kqIVpkegS9HhMoAfopjABbZHn2rh/VEl3yBv1W7XUzNZ6ordcfjiEAzx2L5a+VfmvAEzh/3XZE5aZ5YGCCM63RcR3tTaKYVeLLTCAiv/U9pIa9dMH72ptZ4VCdy9RI6djndIYAjyOqS8zPGMDn/4RKBhmZ+LsDk0xHbpsgzfsWACn2rxkYfSmtIYuXXAjbJfsVeAHlkDLZn3OBU+Ttp/OpuzjlL2ApIU6mN08vGX31114glV/2+z+lg0vB8Oz7gVbX+u4v75+V5/eE8p7i9QP5AX9J+VcWfFQYODXUW9wFLrtdtvjtN0Dk/vhrO2/m01v/nN/08UzEFSnXNrIAXKW0HFxiF6tUR7DmD467531hngWcX3Ns5o+5Qh0NJ+zxvQjmnR3oOj/x8+2AUecfHL9POUA3PsQqufAiJ+jzch/rgBORO80WDHMajSREDO2R8kmOwJorJBuQerz84Jb+cGk+z0uA3QZIncIJzfKf65Cqi95BOn0EekmmvqAdB9Qd3wd2IHYp9U/Ifv5ExMaXr/7br0juLu9RxBfhC/Qa4+ghuPUg3/HEY72ZLofF7E/w/XnKAVbC77E971cBGceqKKiyUeiyfCj9nmDZ7ualm3G9Mbg3/os1TjyC9YHENevh9f9zjcPHDjGv40JgGPZ/wBcgKSE
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 in the secure vault. Send the CSR to a Certificate Authority, then upload the signed certificate chain with the upload certificate chain operation."
sidebar_label: "Generate CSR"
hide_title: true
hide_table_of_contents: true
api: eJztWFtvG7kV/ivEPNmANJIv2aZGEFSWlFRt1nYtOSkQGzA1Q0lcz5BTkmNZK+i/9xySc9PF3hbFPnQTA9HMkDyX79y5DmKmI8Uzw6UILoLPTDBFDdOEkj5Ths94BK9kzOeCizm5Zf/KmTbkqD++PSYzqWDfE1sRLohZMKJZlCtGnmmemJCMmYjtZ9hMjNwi2cvNQipuVi3cI0ieJZK6/Rq4sZhEtd3RggKPJTcLu8Nv3t0hM5QflAmDVlC+jGLQLZJixucDPueGJt9okjBznTFYK5TuawWHMqpoygxTOrj4vt7C505wAIDwmAlkzBSRMysQgABnOe7JqFnAswAq8AYLwL0VKECOKwaCGJWzVqCjBUtpcLEOzCrDjdooQDjYbFrbTK/tA01CcpC9piKeyhci1ZwKrq3SCHmumbWSWXBNlDNeSL4h3iuZg72shWBtwWjMVMtbUT3ziBGVC20/lDgWdgYoDXsxBXdUNd4rAxKkhnDdInQO9gHXwQNLi747Dst7pYdvREjTOJdaJ6gdZo0zIfnC6DOz351CROamwGGLQHgv7sWkri6c0HU0iBTJiiwLsGiOfmqct1lPpGTKqIKNNIqYhrPyiYkavHtOCNK7GaG3NKE29Inpw5acKZnaVX/YggNBIhVrSBySiUSzeT5t3BqBtmg3esBAU+6jFDcDVAeFsAo83txNSOf5tOOiqUPjlIsOzTic7qzh9+/o75uOp9AGCo8E7QfyWcQf/9ke51NnglEMa07tmGWKIU6x9SZn3bpeNbDQ+7jIUXVpoc/AwwxoArZG8o71tZoj/SUwJ3xWuftUghqOrK58YJ/CaQ5ux164Btr2ecoSCUkQuAI1teuufhMqk8gVi0PSg7wmnoRcilrQttA8zRjeb5wieGwcFERbllWTgt3npHOgkJjPZkzBhi0pwRdS8DUXxfg2ozxxpv3rZHJDzrvdsEhkDqQqlTWhbeS0GU30a0mtFbAXmmYJfvvp/fs/sxN6Hr2bns7Out3uCT2L/3TSDTYPjiTkqEsZr5BMMxGC4/zCImMBKJ57CaRqAdpB3F+h5xyNe1fHJKaG+sxn60+4JwXbLCYM8qFZlmCYAp/OLxqZrXeVkZYjlgiFGdFwpnE1kmkqxZXFaFvx1pYGfbvXufhRH+T0WaxeyLTTDLK9T1oNC7roUI3sgd9QwQpjn+L8hxBERBs4Qr9SJ8xbsl7X2R5dvy5rWaMaYgzdE2mQ6l2iLJHMhVGrt8WYLCUBXcDKxJ+B3xjh+28kGg+ROQTbQOgab6oUXe2wHlyNCTiIAkOXvvSG30FVZELbWlQXgBuW6t8AuWAEmTqD1qPm+z6TPjhV7hR/U5W729Hvrwow3dZiYUymLzqdvdps6jH6vR5YsOZWdSaFdnF32u3upghsNee+n4OWJLeFeZYnyQpl/19FPDSKb4f6K+0zlOOb4c9oiJSapoO28d/l8PPoivSHt5PRp1G/NxmS2+E/7objiV29Fx+mVLOfztsgSNvr9PFe2MXh1eCVg8EOxqDKg8XWl0RQDN/OHbi/GbA6TaaUVH2IUVQMnwc1YCDHvw5udbqCmIMUc1uKSqBAwM0e8nvMUmF7CSMDFxm0CWWTH2ycZ23lHN8OjQZYfVOuNZBqlV1SLJmryb458PHkaxd0GPGqqNrPNOExWngb3pM/MLx3grrh71cW70Dz7g/teSNhc3FiazuUPMtmCyPM+jhow+xsR9Se7brh8QFnx0s7kuB0bb+g1nSOs2zgR1/iZl8o6Tj9Ds6/9o+BAVAgP1NB5yxF2OEYSLmQODhnUluwcK69CGrNf+wItl0y7wCWgscdiJB2WlLCV91ZP7mxILIjttNt33w9YKn0qsO+XCXYhvqSEcNaGyaMkM8VFSbkMtidlW+UjPPI9hkHyLxFYQxwYa4+cFy75W1BHiqbjNE1nUcVlqmKs/twoMH2VyK+Qdt2jXL2q6ZKW5wxWUGayVnRDj026DwW02wxncCgNeMvUB3dQOdkJI/kCPKVaziNgqHAYpDRiB23CAvn4RbZC+IPfsBZCOHAafPjoy34dR9cB25I/mSLHejxt2+TXd1qAzSEiNaFeI6SlxnrZkMIUiJo8wFi6JgFZayj3WzVw8xxW00XwyI2mw38vjZru3E+2NbWulpsNKs+c3/3VjVvb/RF6C4zWWRFGtmsCOmPo2PqPMukMn+pnLH0J/65+tT04noAbJmiPASgy2cYMvEuEOQAccA9OP5iXDulvce5TGIby69MQddDpwBPH7IyOirMhmSkdU4FzCpH1zbljI7tFLf/4A30eSWLMk3dHKNERkYy0ej1UGExJJjAM5rUbWSHYKjaMOWRhUz8zPyMHKB6+zQY1cTLtXV3A9uoinXb6ssBBzJL5FI7X/RIW2m/nfXJ1z45AmeG+BgNJ5/IeNCGN/jquI3G1+TkfffkrP2OpAMZddLBlxpP3/xp7A2gukGnbX2xyAQQeIDradjdMd1yuQypXQ5B5Y4/qztfRv3h1XjYxjNgVMNN0vABC1Yso7y0HpDGNOzMfto9PQ/PwhM8iwkfMnhNnuKKFEfp7eCt1er/s/tjn0LwqrOTJbCM4FhrrH01/B48n7q5AuohAtOoiO4KGmoiPDSrovug4eeiuCC2nTgUeiy2QHe9xh7/TiWbDX4G2JQt8WAzqmyYuPIJ6QeeqyuYg6Y5uvWN0vHha2R3i71X7aKACdxhyw28OTXKW+7NQzlH/IfC/bji/nHF/eOK+8cV9+94xb03y7lstnPRXeY7HBfcnr7LXe0Jkql27Myq1YmeNeOre+tT1831GPvkqb8JT+1cGii6xJts+P8iuIc/W2Jsy2NnYfy+DhIq5jlUGtjj6GL/S303Xk0iLtv7B8zXe3P89lBSJnyr2t4jHzCGIUo+ltvdysEDZRvvdqMt8FLq3+WFtRM=
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 in the secure vault. Send the CSR to a Certificate Authority, then upload the signed certificate chain with the upload certificate chain 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 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"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

Subject and Subject Alternative Name (SAN) data for the CSR.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"commonName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common name (CN) of the certificate subject. Use the organisation name or the service name.","example":"wallet.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"organization"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Organisation (O) of the certificate subject. Optional.","example":"Example Organisation AB"}}></SchemaItem><SchemaItem collapsible={false} name={"country"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Two letter country code (C) of the certificate subject. Optional.","example":"SE"}}></SchemaItem><SchemaItem collapsible={false} name={"sanDns"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"DNS entries for the Subject Alternative Name (SAN) extension. Optional.","items":{"type":"string","description":"One DNS name."},"example":["wallet.example.com"]}}></SchemaItem><SchemaItem collapsible={false} name={"sanUri"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"URI entries for the Subject Alternative Name (SAN) extension. Optional.","items":{"type":"string","description":"One URI."},"example":["https://wallet.example.com"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

CSR generated 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={"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></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}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The key ID is missing, the key does not exist, or the request body 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>
      

---

# 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: eJztWNtuGzcQ/RVigQAJYF0s23VrpGkdKWnUprUbx8mDG3ipJSUxXpFbkitZEfTvnSG5N0m2U6B9aBNYkLVLcjjXM4dcRYybRIvMCiWjk6ivObXcECrJ2XBw+K4/JPCKcWkFTcnZeMw1sVNqSQIzRpxkmhsY5IxYRSiZqpTBjLmg5Pc3JFGME6UJ4zwjqZA3bXKWcRnk7re7RKFA2E1zIpUlS26JybNMaZSoJGwlDFEZ1xT1Iy14wYnhei4STjQf5wZ0jecgA4avu/sxWQg7BUUOu12YbRSBGSRmmo7t9f5BTHIwJHVSRjS54ZIRyphxuoSN2+QtjC5omoIyo1ykMEy3nTBakjlNc+43RIGnuZ0qLT55Vfto+8tULby8GZWMWqWXZCw4imQ8w92djZwEC8Af7rFwvcl4IsYicSLb5F2YVbNHcg7C4qRUr6/kWExy77AhM/H2suNymUnAt/EeRJsRpsCVGASaJDyzD8hEm1zwCE0XdGmIi8Q9bgiBkYTPMrsksTAm5/raWEg3J68R6FKZxOUjBOBc81YhGnKjkhu0aFjAIKwktrfXmIFxO9qLStFDBlmeOIMGYiIsTd+7ULvEZK9c/voiqELuIg5CNP8z58Y+V2wZnay2K6fIEG+b0wk9UjnS+NqxpfNmuQEblbRUyHbYQcD06MTqnO+hohaW4m40y9KQCZ2PBrdcRSaZ8hnFX3aZcVBCjT7yxIKgTKPFVnCDo5UGQ6dabYWxWsgJrLjTGr+EDN0zZK/eNCJTQlowTfm0CBgQEgLCevnmNaIDONX7Y1v2r9xSKA+KLuC3dJalqNrU2sycdDqMz1SLZqItJppK2xaqM+91lJ5QKYx3yDc93vuOHSb77PiIHh2NDnnCuvyo2wlYEa33olBjD9v+bncxuuppluSmJ8YqhZQ03g+Mj2meWsiGWsH+JxDQecQpD94oVmJoZD6LTq7qrwpIiT7UI1dOALffDSO1SFCt6RLECctn5uEI/cKXGB0lOQHRAKrCw2gNs66T+m7munRqTHyRFOG9LxvXmxtXRWCK9dWWpLnlZnKEMofsuISIuLi6XuADNt/C9p3AvYnSlZhG7VxF51Nl1ZBV1kUfwBoH+A/79wKnef0NT8FZ5gFTx0pXln6egcdxo9OOhYQs5DBrWd8H8lBIYWvlWK97r+KUBqBx1jUxJEM3CBat13VwvdpGxA/rtZ9jMjDIw2av293G+ZrOvjltgnxwQvQvoLdvRH8HvD1ZuXwzrLIx4DPsIE0jBJrbXEtTS9mS5OyoLzcjJtARIWIZ1XTGrTe78j7uIVirWtVyqwDTf9iU9P2j4+ePer3aa99F4d2jg1P4dt3A/XwJn+2eAC/nPfiq5wc83tUZYCigKO7Q6zf3bqT3tWAmqHGEOm6VFg4eDbwQp04x3ZlE64TIMZL6aJ0Hlbbi53jgP9HaZ+YU2ieUEEQfnw59an52htVzn2utNBIojBX+HtSyB3D8/mysVld5CP2fTxxFKmMPCq53iN+Ru1W6PAeCIGSW2yqfCuu3a7CBA8KDIiSrYHsNRh1GSvjfwwMJDcBU1kQx2/NiWDODuIB6bfKqrJYC67BVA5VTHobnVKR0lHIHgZQYIH0jddvQDmtiM3r7X3D0LiUtifyWa46+6MQewn5aAm4jNkHauW02fIRtnCe5FhZOIVer6DQTwIfgJzT4VfScQ35qPCm5N2g1nRj0TjjuEH/eIY9LIvoENvBpjk4C7aYKD0mZMs5JFEVFSLk9KnaYF9TybaPjQb5j2MeF7WxCfYTKoinG6dq0dgAgHiyFeblO7yX9EZrXFHCuFcsThwB3iHlIwgV4B6J113LjhzcV+VCF4AIz0SdQEYiK1foXQGtxKx9DeJKQAfDcOChv9fDT8yG5AZqLpYIOLe4AEPp8Tw58KG7IiYnfxp8s/QXNWNzyQMJiryOJyWNAL+4EWA0Q5nyQ0YQ/2SO8DbjXFHtCwsKnS5VrdEcLlHsWO4pcT7lVNHJP0IZnFI8PP79/u20bcFeDB0Y4fkBFGFOo5yUFnZF0NC8TSg+68kcf+s2isrQxbo7rIVC8qY7rL4pS3HUW/kcPmrVzZv2cdN8paCdZL7l6RWExj8aqQEeaOHQEGBSYsaHB/VhlaZlo4qfqVTO965WxEaNyEURDzQXDO0Fg/ehFyBuB/2egK61Tc48orhPC0QWOSa4x9mvXH+hyKuHk+jicqp+4W5LdC8/93aLfooSr8yeokVWJSk24N8Ja4RLXmNB4PxVHMOUvY/Yc6/UXXXPcYUkCijVuZ3Lj6sDiZZ1mpuXsFeAHMsZzvU/S4Gmn7fuDPnnXJ48hy6Fwhi/eviQXgxY8wVu/2/DijOx/290/aB2R2UAlndngdf2wMHaFYpAjQJcDSu6StIAIqEjwa6/d3QrdYrFoUzfcBpM7Ya3pvB72X/x28aKFayCoVti0kQPOWUwleRm9Rsr2ur3D9kF7H9diA5hRWdPHX4xtnXU2C7zWvr9eKH+9UP5fXiiHhmP5re1kKYUOvw4lugqU6Sqa9/wlANiKJdKgTf5OGogTtjOkTo0mEcgTdIEpsjCQtVqNqOGXOl2v8bU7diPDg+Kl2uGlZ4AFzUC2dYNsJOr7Wmy9RY1xOiSZIycbtBrJkV9x6gJ279w6UTw/u8AePwrX4jNHoSNNF3ihDd8n0R/w5wx2qOxoO75fRSmVk5xOcL6Xi72bBiZRsagbx6LCD7SsGJLLmpabhMobg99o2s4lTxENgdc8K6f7kTsXlBTEz8aw483RXxfAhcw=
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>
      

---

# 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: eJztG2tzG7fxr2Duk+3yqafNyWQii0qj1Ik0lmy1Y2tM8A4kYR2B692RNKvRv8k/yR/rPoB7iVQcT5w0jZsZ6whgF4t97wK9DSKVhalOcm1NMAhOs2yhMiHFa5XqiZbjWInjVEXK5FrGIrcwNbNxpFKxyLSZinymxFmizOlQTGy6GSwTiFaaUIlHZ6fDvdfHp49FktrchjbuiItFktg0z0S+skL7lXMLlA3Ekyen5lLP1ZMn4lFYEoLLVCT0fK4iLXMVr8VSS6KmQu6JiRKrTf5YSBMBqqGaqBSmNyOLAU9aoPFrN+ET47UIZRx7BrwhtonIg5S4rx91IxtmXQss0tHeMmzLRHdDayZ62l4kEWzZjvRU5zJurwCjytu4tK2jdomkPdNZbtP1Y3F0fvq4wrCr3WPx+lg8+v7q8nFLnJ5cfisuhm34BaMtOvPpxZnoP+31d9v7Yj60YXc+fFEhD2U2l3nWeWuCVgA7pxIV4TQCVWAih0zcFdFGgo7osCVXADBV/watyZ/baB0MbumnhvlgkKcL1dqgYiRhbTKYD3G4I0Ze8D+A3EcgEmKsNSDYORxE4vnFRKs4gvOrWIU5LagcJVfzBEUoVjqfiVE5A5LURvO5RsyWTME/BB9LPc+AlCrASIAmV35no474l12IyApjcwDmvaepBFXI1wlIHo4b5vF6QBOkT2ggik9xnqr20SKf2VT/BxUKTii+je1KrGbKiDVgJnpGAJCea+NoREgPRVLZBMgkdUAGIK4cyEX+yySJdUgw3fcZMv02yMKZmkuaNeuzSTB4cxsg6SAQO34PxAOKXOcxDgDD5CLOxSMQOvM8exw0xfiSZS7GIHQyffIEbN3MgapwCtXqiDOU6X1xF1Jm/cY1W0SIXih7UAWckBnNrxGz02VW3jdBlcjg+q61nWV123sIDUhq47FqE9kv7LbBqj/3nlVf87n3Gq6NnOuwKlrnYh5Ww3wmwTxzib5Rmpo2ksdZzXQ4A41OAcAdAGNdAn9gGzaySWrnpDMc5jrisrRoNFPGTBFv7/W5p0uMFxoshoBHVXx1zR0rsBRAlzPGrKHA7GZCadDNgDcoXQI7tRwCgVjKVIPjeVBXHxDCNuJAIiCTQH2QYEMqQ0/BkVe0qw4s8w6MCQIXmEly4SLEjQFqKeMFfdQoGjhsQMEijS/QG5HoKS5WY52dQBAddLvbzzAIvto883VDx9DHaVqveY68APnAKAI20GdoFyZPIW4FFyewJrYQ2HVOvyE/uQEtmBOnp6xvxWAm4p9/wqgJQUyp/F2BMrhYKrn8+acpuOi9/QB4OtZpPsNQD5P9Z8967d5eu78DoOCRdQyDkDTddN7bGTAT3PU3TgadDLk1AUuI1+/AIBD8e78IZqZ6qYyfOAEUMKazd3ap0nf9pz74+pGdfnPkYN+PJDNr1DuzmI9VCrj+tndw2Ovv7O7tHxwGd3fXIDJWQ5iD0V0Ya5XK4RWjEaO+qML/oyqg5IvM+DdyDB7f59aHDUpcOconqPHvQzjSeYU8rUTDqFjxZzEzTWsgmUStQoXq9dqHT589QztTUxn/yLr7fD2diqPnTa8D2veUBbY9M/jDGbE1sgLUtrnfi4HEvJPnV5ASga43stU/nHOfwIGLk31QioPd/uHO7iexYFMK/SdhhE2nHZ3ZDtHf2e/0P407D7Gnlu3/b7OlmLtYcB3xm6gK/g9MWqawMFcp71svPc7oA7P2V0aDDxLlrsJOKLXPoA4d2w9QaE6l8bEFylfM7blmhoTeObCOuKq1A2hupiQUIS1GptKlhiomXRjXHfFFNRa2VElgD+BD7nfHfCDaSEOLSyWdQaU8ldiIIQDuQDE4VlKbqMfKGsuTKhzkLqYGrGowHfEC0iDFVRUdSNhF7vnQQNB5a96ay+pxASKrcoO7QkULRELgRr6HRe9HQp0lU1gowxDyMNjoRpkKezdAGGytiRu1rrM6lzeuSNvIi6JWdMDEHD01NlU1iqGItCg2t08bl2L/EOUmtwhorF0PCBcDq7YSwe2u81eXorvcca3Frozm2nRlogG6ewt//6HWp9Fd12FoA4YRNeCAPuL46J9tsB8WAVaqrgEXKYhcyKeItImlWz1XhVmofdpQVWuJ9QloWA4nAVkjet76LJ0i/hVsLvSkVPexhWMw2qzUgU0Hni9A7dQHnQFu+h6r2GIn1iK29L66ukV4mNiuVdQRR0YszI2xK1MxWuwaNWx4s3C88ZAdeKTcc6pjoHVMHTNFRBo9ISxoUAm6MAddYyumthuUAyza7y4vzwVEeyz4yTsxk+CXy/frrK21BSbgMSGpL5t/ruMChYo206Cs92Hs4OnTZ6ov98L98c5kt9fr9eVudNjvBegbQaETazLuC+z0evin7g0rbRJwyaQxje6c+hBCxTJFiw5tGhVNzmqbELnDWuV3pD4MdmnwuiEGDSQnz+afN/fMwDeo5kaFZGSaynUJuTGfLhDNsVEDAjSEkjHVmkFQ4KxAV8UI2DFqkS7AZ3/0q5qxSYpOPNfM2JKi77jjf5/Nx1v52cJ2Jh8RNHc738HnewEVIchHdaQdjrulP/yxlLDeQwkY3rBAmo24Oh/jlVxjFMwXKfgEBfWo6/QjXnQio0o1OZS5HIEBuxW000yiKQrKUYT2qOB8ZD86B6TzJF/zgoEYvQ3eBiM6PGgVWUJLjHp+hGtfGCHj8aNja2Ml2Z+MzCKO3YTxCsk/iP/3WnNolCW7Thy3Gj3R2nDVO/AAXb2cNYcjYMfRNFWQeJm8HMnhVOB21Ws8cUbNgCOKhVSs6uwSI2JtpNY81BkU9mVdXyPzDE30/oi/GqtnZFDwLDJqjLgPljmO4z6yWnO7Tq6f0xER+eBoEwVW7RtxH/O5kuqp3BgHKjw8YSbjjdTxDCMhSKP5+wcF8Oxk+dLnVaopOdeFAEjcPpkkdqCxHSG1fOPH37Gea/ge6iyMbbZI611bQuRnfgAngv66uuCFhMDycd32coKJ3Vqo1qdqCsnd8Brab+nuEKXL95Ev1dKyoyP2+B+FEjCPjkDlUreoMXKJ/ubeKF8pkxZyegLZdg4arrLcb7Zx/Nyeb5vaiBJsRUfY7quesdAJM4F/3+fMPmsn/q+jmb4raCOFWhNdbSHYqXH5NeT15UAFlzfOIVRVKnqpJPf81IcEHcxxndZs00xWO9NLF1lPTJiuE08RGeZlCqnSBedz56ldapY5C3/LJOSpGr4XMiZFmYOuqrShgX7LUwiL6ZK0O4M8GRQjRYOdJ9WBYwsxRBs04+otEbnWgFuQ9chEpZpLHSFi4q89TlE+Og5X3bVKU5s670Dfw0rcu25u3mrE8BK6TLfAL6opMatIt4DAuw3o76Vo1QztuYTqwiSQThd1aeAK1fu5mL+Ywuhulqjbtajrwy2Ff3bPnBltuJmFEXzpABHO5bwjLvv5AtV3QSEHYgTFnRViBmebcyZsxB6ux2TYD/R3BLgYyBOwwt4EHto51EE+km+/WPOw226MN55CCmKLePXqdOgRNDMNOgOm60gAFq0PXO4B5sgqxg2OMeTUg3WMkrNazkoXkpjlZygX2Kas5kNMJOLMOiERSCpXgrSFbzpdlV0gGkOuhVWUK+n8/KjQxhFnLk2FGwllllCgJJT6NW2o/xe2oVdGFk827rFm/y/tXsiLG8j7sfIHW6ZtPs676Nxfb4MZ2dg1hcoQQkn1qBpS2Mn4qOItvQHlKoBkkc3Q/CByhr7XBmZRGh81GfhFC6Tq2LrIm3oPp81UuEjp4g+KoCPqncAnxaLn1FjCJJJGUFxyis3BwD2UEhzyxSP/ROAYX0vQk6kUpTvn/HEQJJby10QiqqDSuqk/B3Mvx7pZ9H6Vd0v/1iVOY9gkGWzqTw7V3DoRcYMWewd5nmSDbjeCOXyK1tH0iqmjbYDHqyOAIB/x+6xtaH4JA8T2KTrdLeAZTzcJuS5FwD1l0nwviDIh4IEtXZHa06l7xWvRsCtbgdSoRB3mOtJ70BqekW9B+pYSRIOJ/lAEKKZRjMQj0ELWbYgomh4KZokM1eOWUJ1pp4F2IBzgV9jAQnZgi/DrUQc7NFWVuw24s+lS70Hw/dXl/bNVup5gyljiMXmMydGMvcf687KCg5lv5PNmQeGTUG50T4Ae7mX56O/E+5DPeT+wO5FP9ycHe+39w/5he2//YKc93p2E7Z3w2cHu5OBATuRBUO3i4yXZA4VqxQdWyq5Cvd746evNdwx31WGoCiUW3jy+DGvYIxs2nW5xl3PX4suMsiHXvOv4I6m5fvBSs4BvJE0OUbUsqCwu6oPKWKMWcE8RNhUEgze9Fv13TVtMrA/Dki9+/DMKV5J+U3qVwjHov5dDdXdU9WQNmyqA8N0yVj7YkYTsFLQe7Fzj33nxhMy5jk96Fo1Z2mbA8+ortSK8nJcvqX0iib5NGYTJXJeZDZxa0BQ2WtRU5b7oEndYCxd1Kn3DzL3wBidtIplGWZvOi2/PxCS2q4ydiuM0UfvbvUem/kgI5Sw5Fe/SwYMCX3c6vXuiW61WHUnTHThy18Fm3Renxyc/Xpy0EeaufGBYihOZBSaxKKQHqDGesth3ejt7nd1OH2ExYM+lqdBz2njl2vTElQTxy8P6v/LDeudw8W62m4CzNahPpMC3LgF8Eyx3+N4A6KfeX5V01/+lxiIlgs1WISeD19ipwZcwb4Lb27HM1Ks0vrvDYYjUKeWwoNz4fHSMVoAZrU+bKHvUGU6U10ZblfnLzfeXm+8vN99fbr5/x5vvjS70BuvB+/ff7rFSQAUprzlm39V27Xq/4l7XpoQ4IjE+uLZazp+fXWAlNnb/F6g5lz+pXOFdCPw7CPDWkRw55WLUFZL0vDSWZrqQU1zPeLHCkq7eK2vdG6p13UflelaadYXKZtnLh8F/q630GshXaMNgJV8Xy3lmK0BRKPJqlMU1EP1fqXLFZw==
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

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>
      

---

# 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 the signing keys of the organisation, grouped by secure vault. The wallet uses these keys to sign OID4VCI credentials and OpenID4VP responses."
sidebar_label: "List keys"
hide_title: true
hide_table_of_contents: true
api: eJztWVtzEzkW/iuqnheo8j0OJCmK2hCHGQNDPOtAhgFqre6WbeHuViOp7ZhU/vueI6lvdoeEh9mHHV4g1uXoXL5z7RsvZCqQPNVcJN6J94YrrYheMqL4IuHJgqzYVhExN2tCLmjCFcXDLbKQIktZSPwtUSzIJCNrmkW6Qy7h6IZGEdMkU8yQU8wS0sIQJhfj0fD92ZgEkoUs0ZxGitAkJBcpS3BrQiRTqUjgeudT8ilBkvkKWfA1UBUJI3BVbslcSMJosKyxAa9Svcc1CUQy5ws4FbbIhuulOZFmfsQD5NAwgUuj8ciIbejCBkrFYSVl0hKSTGcyUdW7MdVMgijAWgQXxpokbM1kcdQ8JfkajpGUSo30qSFuRazRX1JFEkG+ZgwkhNM0ZkDdagnWU7rgiTlpHsqfwPe2hhnk3fywRvmUeC2voD4OwdZWFSO+4JpGV8ZeRv0hguA1WAtulA97Jx9vdsByYf6gUYe8SzgwSrix5ZyDzA4xCtj1xXXdBgACwIUxm0ahJYPLCoBztWQJ2YoMDGnMAHtLRkMmW5YYk2seABAyp8xSWzwxCyCSZtc6fz0B3sNGHloWHly1CF1QnigLFYdacx22G7m3BtC1ezH8WbtcR12HvGF0zcy6FYiITOd62CFQ4L0QF26oqjYMvsgmVxbNgALoPUBcGUxT4jMq4SANAqbQ61Ysqai34UZCTidjBE5d1ZqumLrbknMpYrPrLhvlgH8LyWocg/cINJt7p41HA5AW7UbvMJDPnSviYVDVnUwYAWaTd5ekux50Laq7NIx50qUph9vdG/gfAD0Ob7uOQhsozAjaD/gzGp/92Z5mvjXBOIQ9K3bIUslQT6FBk7VuVa6KshB9PMmYCXOo+hQQpkESsDWSt09fyAXS38DjhM9LuPsCxLBky5jXKHCcAezYNXhpy/7ts0hAqIZXgZrch6s7hMJEYsvCDjlNSJasErFJKk7bQvPUfbjZOLnzGD/IibbMU3UK5pzlziqFhHw+ZxIO7HAJWIgBa9aL8dec8sia9rfLywkZ9nodiEcc445VEvxCi8DvumphHQMKhxDvncwhsbCWp4Ili6l3cuPpbYpXlJaQ3LzblseuaZxGuPbk6OiY9ekwOPQH84Ner9enB+HTfs+7/YwkXTpCIoNeD/+rR8O6y2I4ZgV+GzMoymMCVqKRGk3TCD0SdrpfFJK82edb+F9YoDEwSwx+mluG4InfaUIXLAZiU8uEqlyjUtItKiyLIuqjtFpmoJedeH5PRm2MbCj2mkYY/RWZ4QMzG5r2Uq/LaDYfoS01i1WTbHWuXjv1Yb6v1Rl7WuBhhRoHxS4MSurkplWJxqMOmfVnLhWBCL9KmugOd1y2yGxQbv5G1ZIHQqbF5kG5+cfldFKsD8v1kGrqU4jyPg1WAIiCdZZkMeTUfmvQOmgNP1eA2L/Nkb0L111Z3hYRaV81jr7HFygSF+9xA9aXuRT5wletUqTsvzAc2uUqPzskgDtE9A+jy9ixKMqs/pciCpXFUAThDCHE4lRvSwRVziF4sFh6OHQQ0HtFnWEhEKA5k714E5DUiM2NsOUTvhARo8k+npZiA8BHiSvAd7UA1roqrzNBOGQGyuXQUjdmyrWMBEC1XzarJrloGHJbbE0qnLroVmdoUhakkF1fTS/ekivmE1A/efTq6vVjhCZUqvXUhRlI2brClCMs9rHYxNC9cQVmLLDqtjUlpCqI7vZUo02huAaULYGDIMpCVq99Ta1s787C2b76V3p7P/ZRHjxRl4NGGwows+IYlduH8jiFDELPAVyAKFGE1AICjrO2YbpFlHCi5BHt/GxWs5N3foYuEMj1/Tye118oE6NlJ1MZNAvlU5P24PDJDJKzLXka+xcep0JiNRJQzJrKlpAz8P4ULq/6O8waksjv9f3c/gleIWSIbUURVXZ0lAoIqy3EFca0J8NMRjmcas8+K7bb1+2S6nPk5AG2/fC3cLLd5WRVSxjfwVnFcDXiB/MBPe4Hw6f+UThkT+a0FxyGT1n/yD8eDKGEwEdotLj/kSnECaoxfsNxISFexEUGcc1njl7FNKJyilAxZygxRs5DYwWo09z2h0FDtK5zcIbuN7cdQbDEbsTp3bQE8BOC3xxLOCkE1m6m+D3HEgFjMcKXOktACRGIEBA6Ov83CUqyO44a1h200tPQ6i3HDJyLeIIJ1HUCdySCO/SLieAe7rxboyn9AGP9dtruAxNZ7ENES4q6yGjo7xa4EdlqSfvtkqHn1uj6FwOAB8mDAHqIRG+FtjX67JdZ3nQ7ebBkcXENGgIaNghV9ut2hGNbujgPt1AfzoDt/ygTBr8jLOzXxb2t1vwfTQL5DGshD3+8TmkqEvLk/YOQC1mA9TSF2gYMWemLHsEjjzu19uMjcnsCb5x8G4Txt9FRP1hMro/er/jTV36W/R6//CCvJosPYqu3q3d/HbDt16Xufzl+7X/9q9NBxvD+hvknIaTqNnS8HVu3QTV7Uk0hJ4fzY9r3B8EBxKzD+ZPe0/7R4PiADkFlO3os6yBbmDiNwrndg2HejbnicP9Ic4tiz7muF5SKv4a2u3pwa1R9hUkp5Bk4OKIH/x5VjAJF7ffbqPJ2Ux9RmAoYvG0g3wCJEsAvwCF4kma6nOUBbI30+21kPePbNhtchEOP7ZJCU2NlR5C5iqFigyo/RGDsqrf/D1bvuwSHX5Biv7FwTzWH/2jkjeE9CR2GSVkQpMwzOzqCS6bR5Fiif7zxTs1gDf6EcHvjvTBTx1NQsFlBqekCJ8eemzITO2Ymj/I5/9ljeABLrDI2oLKAy6XAGfWCGV1RpOhVxnuhpde2fVYXVJnwsAse0C49oLuyM2wrTtMAewSR0kkL5yC54HBJ61SddLv7UdRDEXd6LSnCLDBOeAeZ+yhMNQ7yF3ddV3Z7l5HPpRmmiEYLotwYZcKzC3eMzU6dIxh07+WvYqJbzop35j2uSJjV6MzyGXU+c0wlm/NrSH92TGt5JDPyKMlLCUiQPDI6SGnAHrcI6yw6O2RPiLv4DCecqA6cIT+fmRxahd2NZ0ffL00vAHK8urrcl60yFgevUCpnz1JyPGN9U2OCFBo0IcBMBcwFr3BvtJspR3gyF3ksoYGJJRA0ONpWZSn2cP8q7VmYpJg/7QGhiqEdacqhFcSUNcdum2LtAu4PGub4P7qDFcEZzfqf6R/eMwlFCdZD5KzyNW6soDtNoHB95L7VPa58oNu9OJFMFU8Uzj15jBxpEYhIue9niCqW4B3lcphVrZkOc3iStcwAwQ6T1/jCljhnr30szJRBjIZjVIaqbeTloAcyj3AgY8zpNG24vTo4I+/PcARyCRAbn1++JNNRG37Bqn1tPL0g/aNe/6B9SOKRCLrx6E3lTddeKsyokBNYokywzp0JsAt6HXR6e6bbbDYdarY7IHLX3VXdN+Oz87fT8zbeAaNqrqMaBoyyQhFkhfWANEYya/ZBbzDsHHT6eDcVSkPgq/CD3/CIC4BhPVUU6e3n197/66+9LiThB9FuGkH/hUgx0LxxGfWjtx7YjxCgJVPdV7Oq/WCcmNq+nlmLKh+KA0AeErq5wQ7tnYxub3HZCIJFACCWSm67LSwS8ixkkjGYCTbC5kFmFag/vzT//NL880vzzy/N/8MvzY3Rc4Xl9f73ZlMPw4ap7+2ZU2OUyt5eJ3lb7XN+PccqlboStizfV6Z8d39gzMy3km2F9m4lb1nAf5GhxivP0I8Aqc+L43bnzgtF7WtPoz5wePNfcBdorg==
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 the signing keys of the organisation, grouped by secure vault. The wallet uses these keys to sign OID4VCI credentials and OpenID4VP responses.

The response gives one entry for each secure vault that the organisation configured, with the public key and the DIDs of each key. This operation returns public key material only. It never returns the private part of a key.

This operation has no query parameters and no pagination. It returns every key of every vault.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service returned 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"}>keyManagementServices</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"}}>

One entry for each secure vault of the organisation. The value is `null` when the organisation has no vault.

</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={"integer"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`]"} schema={{"type":"integer","description":"Secure vault ID. `1` for the iGrant.io vault, `2` for the Hashicorp vault, `3` for the QTSP vault, `4` for the database backed vault.","enum":[1,2,3,4],"example":1}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`igrantioVault`, `hashicorpVault`, `qtsp`, `dbBackedVault`]"} schema={{"type":"string","description":"Name of the secure vault.","enum":["igrantioVault","hashicorpVault","qtsp","dbBackedVault"],"example":"igrantioVault"}}></SchemaItem><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__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Keys that the vault holds. The list is empty when the vault holds no key.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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 the members below. It removes every other member that the vault holds, which includes 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 vault creates 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 usual value is `P-256`. A key that the organisation imported can also use `secp256k1`.","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.","example":"3f2a91c47b8d4e6fa0c5d7e18b924f30"}}></SchemaItem><SchemaItem collapsible={false} name={"alg"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Signature algorithm for the key. The vault sets `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, in leaf to root order. Each item is a base64 encoded DER certificate. The service adds this member only when a certificate chain is linked to the key.","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 a certificate chain is linked to the key.","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></div></details></SchemaItem><SchemaItem collapsible={false} name={"dids"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"DIDs that come from this key.","items":{"type":"string","description":"One decentralised identifier (DID)."},"example":["did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...","did:web:demo-api.igrant.io:organisation:5f9a1b2c3d4e5f60718293a4"]}}></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  \"keyManagementServices\": [\n    {\n      \"id\": 1,\n      \"name\": \"igrantioVault\",\n      \"keys\": [\n        {\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          },\n          \"dids\": [\n            \"did:key:z2dmzD81cgPx8Vki7JbuuMmFYrWPgYoytykUZ3eyqht1j9KbqZ...\",\n            \"did:web:demo-api.igrant.io:organisation:5f9a1b2c3d4e5f60718293a4\"\n          ]\n        }\n      ]\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 organisation has no key management 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>
      

---

# List Qualified Trust Service Provider (QTSP) Credentials
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-list-qtsp-credential

---
id: config-digital-wallet-open-id-list-qtsp-credential
title: "List Qualified Trust Service Provider (QTSP) Credentials"
description: "Lists the Qualified Trust Service Provider (QTSP) signing credentials that the organisation can use. The wallet reads the list from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call this operation."
sidebar_label: "List Qualified Trust Service Provider (QTSP) Credentials"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/iuEnhLAlpxLty4oimVOu3nLlhR22wFdAdMS7bCRSZWkkniG//u+Q8qy5Mu2p70sL4ks8hye853bJy6jTNjUyMJJraKL6FpaZ5m7E+xdyXM5lSJjI1Nax4bCPMhUsFujH2QmDDt6NxreHjMrZ0qqGUuNyIRykuckz51Xos2MK2k5aWcpV6y0ImYjrDzyPBeOGcGzcF6Ok9nU6Hk4HbrxYHQ5u/Mv+rkuMzbEYdyVBr+1sto4Wc7ZUX/YP2aXt4OY3k7ljNa5yphQfJKLjb4HXuaOTcRUY8NCl7Aoz7EsLdOFMN7KOOpE9Y9BBkhSr/NKzqTj+Udv9k0hsEZYvXO26NeeQ7bghs+FE8ZGF5+WW+je+Aeex+y9kl9LwaQXBMqG6ak31MLwiX5qI+c0Acdgd7DWCAhbF7OPd0J5T6yAv37tDogK0wnKqpiZUgWQa8+YVP4FnHPiya1PV7A922tDJwRV2g7jMy6VDQGuwujFsbzXegqF0q4lN8djS7idKzG7FvwhhC44xHTp1jhsKYj/UH+oUdPdKqlqNJhW+YI9rsHiJTQA95Q7eCDdHePICm6wkaepsJDV90I14N0joSjj2L1YtKF2/F7Yw5GsE7wS9uAgqZGRLYtRJJrCVp3Tpa0+W+E1PxCgifQ5ILxeQHXQCO/A+Pb9iCUPp0nI74Rnc6kSXkhIJ0v8/0UsBtkqqTR0oWHMKH6wzyM+/r07LCchBIMMa8HtTBRGEE6Zz6YQ3aZfDbAo+6QqyXXtoS+QYQ6eINakPhx9Y2ak/xGHMzndpPtEw42g1m5yYJ/Dc2pg4gn12gnPE5Fr9CycCm1mN12rTeRMrhcii9klepe6V/pRNYq2Q+Fp1/D+4KyLx9fBWmnHH9XW4PcF6wIoLJPTqTDYsGUlcmGOXAtVTL+mXOYhtD+NRrfsvNejXiap7wSQ8Isigt9taPGeGopEG4supujfohPZ9E7MeXSxjNyiIBHrDLp8tOpE4onPi5zeffPy5XfihJ+nLyan07Ner3fCz7JvT3rR6jOptAV6tLCk5LTXo3/tbuh7cnNs0Aig9lP6IpyWeb4gF3yPUo4U8KLIqQihIPliScty11Q9+SJSR73YUL9zMtjQOKmxmRvDF4QMTqNpEV04UwKAtqmDK7tuU97qPUMPPR2t6aTahkeS2XTZaixt+dyYO74wHnhOU8GyMdkzDi2rPvVO5xmlUFNBmAlb3ZPi7sTc7sZv17GQtAe8ilsB/xS9+op5192sd2X2Ovq8WjUz6FMLaSxitapS2EO/zkM2/Ou4NnULY7Tp60zAFf981fAHaff3ObCR3iAjYcXMV0ftKAxc7VG/B81NMfzA0chVgc5VU4BotfLetyEftelI1RTqFEFbqELqNxkxxcgLfX099qNdQE/+x4C+VzSetZF/imwHmhf/61wb4DwDwuknLsaLP2YLIwhZkZZGuoWnrJd+9OPx86qzjH7wvOgSAPs35DWfEbeNKkbMAiVmR54UX51/6B/jAGhgv3LFZ2JOsEMMVt5p4tMz4bHipDFqEJAs6OsGRpEASiWzBGykO68VJdR/kmZ/IePJtX10+0rMdeU59pUmp1HoXGEvkiTDWhcsJ5Yzw5WLpY7I3bYCfOtkZern7QE1/6RhCLSopR4Qt2F525DPm5AMKTNDQq0Ds5ld4cWBIX9ZFYXP9J3GX/PPDbPdmkLVvBu39IzXjHrNkED2pvIJDSqQymAjG7MjNLVATpwBMfEYFDwVxx0m4lm8pfaCVYKviI8RHMR4X4/9/Gmm4DIKRP2tNnOOco5+/jja9a1B4lEh1q7NC5oqm2k4t4xgNYK+HRCG4bCoLnWKW0QVI9VUr/sKT31fQQORFFtbFgW+TL/fxLMOifxx86qdCM0c2vKmFoLd/tPbYl6nmloBEJb0n0ojuFAFLdSiJwcfhAG19B/C/QbXGlhbcgUOfnTji3Zw7NnofsFbkLn6iLrQ8fEPi5xONbGfEZF8yqrw1W0rRhKg9VxW4kjR8SwmUN8HOmHBqsJvUcHS+oxx2MZNZrveXwkc2DTXjzaEs0LaW/vxrM8+9NkR8gEpNngzesuGV138wttw2mB4w05e9k7Oui/Y/EqnyfzqeotJIaUsTVfMBwHqSlFdFxNyF7iexr2d0D0+PsbcL8dwOalkbXI96L/5bfimSzIIqpMub+WAByvTaVlHD6qpk4Wwn/ZOz+Oz+IRkC20dmmDDHrp7+NdXNP1Wv8zaU6aejM93P/Gm0OlSJClyjs66qgK+rGbWp+jhNHyV4DjCszW3wvURJhce2rMLL2h6kWiTH2MYI7qkdrmccCvem3y1otfgesaPYWQFNzJ8nNBQXnd6P/AAMBY2H24Ho/t89/R89/R89/R89/Qf3j3t7aX3RGF3b6A858SC59Bhz6UPSmNt58tt1fyu+PENMUFe0cQNRb73FLl6oJ65XlKLhu5tthxMoL9k0F6RV1RHyNTX9fawclCg5pdhN+FB1yN/AaIO/L8=
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 Qualified Trust Service Provider (QTSP) Credentials</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/qtsp/credentials"}></MethodEndpoint>



Lists the Qualified Trust Service Provider (QTSP) signing credentials that the organisation can use. The wallet reads the list from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call 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"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

QTSP credentials 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={"credentials"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"description":"IDs of the QTSP signing credentials. Use 1 of these IDs in the configure QTSP credential operation. The value is `null` when the QTSP holds no credential for the organisation.","items":{"type":"string","description":"ID of a QTSP signing credential."},"example":["<qtsp-credential-id>"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentials\": [\n    \"<qtsp-credential-id>\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The QTSP vault is not configured, or the QTSP 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

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} 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: eJztPftz2zbS/wpGv+TxSfQjybXnu7k5R/a1btPYtfO4TpORYBKS2FCEQlC21Yz/99sHQIIUKSmp+6VtNJkkEgksFvvCYrELfehEyoRZPMtjnXYOOv1MyVwZIcUsU0alucQXIlKjOI3xYyBeTFTbSzGOr6BzDi3CTEXQIpaJyBczhJhG/CKR8RTbyJy+X6ksHsUqE6lSkREjnUFTcTpT6cnR41dn9n1IQwVv0jfpNzBGfYhMvZ/HmZrCVxgJ0T+Kx3EOb/pFIyN+nKtsIZ7JdDyXYyXuH/V/fPZAvKencSqGUfg+oTZDnmWBWmw8hPaCXZqMDEM1g+EQCgGJYZY6TRaE5SoqAS5aTHQSManyTKZmprNcGJXncTq21FFXiJg/f5qnMjlgO4HHuTkQQxhjplOjftCRGnbFMExiGPMkuggnQA98EoWHs/ice74AXuAzdTNTYa6i0wzolJohzWio0jBbzODxuQV6nIavZAIdL+YzxFBFQJqnOp+Ihw+PgOBhLs60yR8+FPeHEX0fzOA7jVp+DX65zocPaAjo1heHZyfcIxzIWcwo4ifbzs1ITGFKwMtMCXkl40ReJopoez5PlCdBRmVAJCFnM5i6OXiT9sQQGqtkiIybwrAy10BJHH86B+pdKvFI5Frs7e6KcCIzCZTIjEh0Og783tQ41dRBCnrIo4KAqptcpYZ5QgiYLsmuupHTWaLEvUOQsFce7+51xb0jHc5RRsVFPE6B0fcE9Lj3faqvez/pedbrw4B6CnO5//1P/Qf3GJlSKqvTuZ6otGQ/MRYbDK9mg1y/U+kQgQ8jdRWHauCaAfuONM0JJDMScd4KJo4sGMLiWIYTAZjDuHrk4RSUSghCxCoM1IHeLFJSDIEqU5lblXLfRKgBmAalvJ7EAHo4VbkcindqYSo8ZR0DMZ8aPZhGOhyKXL4D7g/hMxqWwRXK55AUjwTp/0zUQzly7a5ACKmNYYKUnQxIHok9NB9chYNfjE6Lbn4z1mrG/6oYoIukLkbzAA0FT9IQLCC2NzuB0pMkgThMgZIw04yeAsEzNZobFTHPyUgOwByURAU4aU9NZ/nCvkalzTJJpotIJqcVm0h2bVPmtY+laWlwg1mRJN1GzT9X/PllFpPYwNz0tYqIYjXRIgNFouVbCiarZTfTwKBYjkh4azaER9/ESq1SlUZEAmapW6UK0z9O9CUQE8R1FI/nGZthMgwzlU0B0cJaWbR4meo1mN3N6cN2kfW3tIx29nXLvTxTnIBbKVCOCagBk0Pm2weJq5KcJyiqumjCsuyQqLSYpw4M4UIrF1hPmPORzOVRscQV823ArFgvQRnMO7viizO5IMv4GiikcnGYgxfCKycwRfx4fHHY94WbvYSL/iEoVNGyWHiHsdF7X+/uPRp8NZBpqm4GoJTAUrLXE/APphoWlQyXkYO67XMrxJLl7OJ84eVhGk505jW8ebL794aVt2yQzpOEu68kl2svL9FraFqkqQU6DrCOwkIT5iBEOlWwmGpq0rU+Q90KcEdQLd+OXsewjEu2TUHVmnZXmRuSDutwDUjk9TiTMzDjA0RNZYPLOI1gdRuiP0NiA3RDoBY5hCZmEkYv55Nfa6ESduCsVV4yTvzUs4zoGeBSZpUK2N/pdjToJUnDSQT+LOutdQZZtsiTi84836xkBPS3ivNUR4vOwYeOnSjAwkl0a+7yM/QJuu2eKFqTZe8OjDAqQqquW71sQARXSHiFSJBrw27EDq5S+MyglEl6my5OR52Dnz90kIWAlb78BeQGQORxnuCDI9ZhcR8IIMCsgef5wE6V5/Zzh7ybztvbbjuUk+MX/xEXR73vXr8Qr/qdOi3OWrxd9pgKTU9FFY5PPCuSpYUIPgHLi1NBut97IqbgcO1Mj579Blxr0NDwAMC7Rvr1oz6S4j6Q5MGnIissEHAHkLLsg2yOHeDXsc6rQak6fvr69ORI9GrswldkJPAD9z3oHM8zUDsg19O5iVNljDPjp9cprKEA5j6Dw8lVTMb3anFChMTFFiA1vP8PTQTeRXF0AM4SNLGmHJ7ZT4PdPXhsQk3kpRmWNh2bWZ8YwVesNLzLrAszmGex1xOXYxq0cBGQMc51wtl7ri9pX4wG55kay6R3BmiB/XRTY9XtodHvPTs7OQJIo2JWzqGEh2iKicCFz4ocIpAMsQoQ4aFcddhAExJoV7FTXFKVJM89TxDYc3AVkeWFJKy04870TcGExDOU1xFMWYHE3MLYpZw0Kd7nkxZclf9iouLWbk9SKus2WpZsHIDzExAjgifBXpDMYLBmGVlqDIDb5Kap7e8nSxV7uLU4dytG3nbXkyRvwwuw11qdFrNTYngxd4tcm0g1tf0dzVPV67jPcaguhWJU9FulzMErwP3ppI62eyRw1W0rvOM9Xwf9g8qGBJk4yfOZOdjZcRvmwPoQQainnbfbFfNTRPKl3WXfmVCWAP9KYumCEVu/7BOkDPcId278cIg7MICfwXUrQmJ3bwE3CFcimMO9/a/7T/u9by/2n/wNRsLv3/R/wE/wAD9trekny/mdW1Qc5E6s6h9P1j2zuhXdz7d1/iN7qJ9LaP8U7umXs0tfLbZ/TC/2jyW6v68Lu5XErae79XS36tCgDluH+K/oEH85Eu4fEGw95T+pp/xlHkQ0i+7WW/7c3vJWGrce89Zj3qrECpXYes1/Ra/5C5LyW5L0mcwAIta8EK7VbMNT+iCTAAQzBoaKEl2XuGpkGl3qGwEuv0xjw4mJuaYEY0xFzCdUz0DSEIjXmPi90HOuOKF3EyUB4W5R6RGHmI2dculHkcDrChsoEfYmL9JmAfeoEYcup0TGmEE8lmCCuT7omrWQusPrRuwxU5dSib1+U/hY6awqfQLxTElbisYTEnqeOzrUABSp6cV0oYfxqeGVBCCx5BwgAN1BxpRL4rxUMrNFMQbz8UFvPfI29EjJyLxTiyqpucSllZOjTE/pre1MxAFd1pmqYByIFxrZZsfpYdMQM4xh1rKFQSijBBsbA6lakaAJDM9evhA7V/s7nMa9I6NpnO6A2YHeOx/gfzKRtzsWQg8gDAXyD/Ajig//2wNdYhaccFUIjhipGRg2oFNE0sTc9eflEQulL07nigoguB5JxDnMBHiN4Hno02yM8K9hcBGPSnG/xFo5BmtKGWiaMOXCq5vYAGxbCYAFaTgqQMuWxdWVC8BkEr1QEdYUiXn6LtXXqae0mE1f0+Fm5jjlIT1wQDkXvwqB2jF2TBQRxaORyrB8o4olyMIUS6BIiyn3XMY2YfrbFy/OxOPdXUxHjtHuMJHgG3IEvldJ2/GTlsmedb0MeJtWbfIM7V+ZyAzP/vb1139Xe/Jx+ORyf/Rod3d3Tz6Kvtrb7bA55fWIEp73d3cpYFKxhl5xUkilsSy9d5G2X88Fn6H3kOUxY+OP4NUnrO2HS2CdIPWE8hPAMEupWCHUWdRg4VcW/yYxSmoazXScYv1TPs+s6ablkmrMmtFHFZmAoDAcJmiXTCGJ2XwWoe1yoI2FXRGw2OFeIg2Cn1zLheECl/aRUVSjKCPbuYqHt1REAl1OPWE+2YSuS3R0VcN9q1BU4kT6A0pqjekqPNomsx6X5cW7Xi9ra7X1aoa/pLUM0PQgkX1vrEumlYJXbSrwsWRADncde7FNpMAge5ymyVo/et3Mvp1PZdpDkFgQ7JflltXns3k206Y07C3Tq5XsUrnuQpyBR0qgi3Ldw717LLKRNJNLLUFnzERfWwYSBjSDinNa11OQvZhdqzNPY5uqij62dr02ec8rXl91z/UjbsVnT7JYqBg8V6pLvyKrKAf1a0uxsM7W/na9wl9bB8zfegb2yCg3riaWyXOwVM9L9Z9FsVp3dR2vrRb1SnOpVmy5iV/pS+slYx5Kryi/qHfrVqrNuhsWvUE753nbkjWqGlTRAB00ncXIdxwcVG/WS9QVSG9DrRuV2iFe40zPZ/X7Dux1AxWvEpiZoENamBUSsgU5pUXxZduVBMi7VPtlQm9SlOiVJYvrdRVbkRKWYECHclkXxJoZQVoa1jimLjs7sJ5m2nrcSxAv1QiLOj2HHx2wZVNvr3aglcqAGQpzbvPdxelzQXtfuWQqqSgZLCX0ismG4bt6OefQWbumKQXiHFe54TfHFYc2Yk3vMcY7uOzE0Y6JQE53PPA9nGGvZJcVZ8KQMYahFWoisqOQCp5kTFrJpZzMpvXiQAxAgaiTmWssVTqf4o4VvQ+u2x3gy/Ir7lz1OE4HWWzeDTwgrS8GKfzNzd4+Wsow1HOAyRsdHI/LiBXKF4wzkONMUYnlgD0Y9zyKTZhoMwcdbWjyXhlGk/bq7M0d5p4Qw6wuyQVdWkpvRB5Pscx4OuviAmcAJlCo61g+1eXK7slN6TKuWed5afydsUkk6FA4gSVkE5SKUNI6HWcfhwSS77ugtdMvWjTifnF9yoOiDtsie8hW8VdG4typy7AMYA2X7l8Jmiu87e6uPP3+Ckw8vBN9tIajOAFnk6+bKKomqabTXzD1lWLFalqEYZcbeOJfibEtI2TlrD2it46y3+PNEEs+Je2c7VYNb4xAw4ShNnpZYktMbIsXrhuZ2xXxHr6thAMJvsc0tDUBvCJTHXxwQoXOsJfW155Lgdck6MR5KDypfFG1mOjJN/KVb6Ww8D36lxUJFP5EcttI51qZRakT+8GuoA7WUnIZLT3pXUokbUVBClP+22wru1NgW2kgYlM1KLs58sXdE7lbZ1cpVHEvjFcz3KKxgXf/S6Ue2ip7XwNvwhxj2i84DLV0XUJrGfURNXShYN4y8MVJ7KM1SEBF6cqItUORKFQZ3ab2VgPa6+jap/Y4J1pU1xG0LujlbVFOZfEiE3AxRm6TVY0lWl8b3coyzj5kX0MK91C8PD+h25Si4tXRyVGX7CMNN/AuwCiavHK4ePdo8BEGadHAyHQQoRvBng1gc3H4XBw9vyjiYcC0/wbQVIS4UyF3Rlm3miCAwzjxuuPXtm6BeI0RH777g4KK1RueunUSOHGQAn2FsLLZLyO1uKtMSjrlMhurvHKdTKs7vImc1U4/gAF8vrJEdGt+HE3dV6QIiWHjZTkbbODPT8oVvElyMFAOS6sc5ShzucCCUdMosEzsQJw6HSP31b+Fp8qRxjt5qlRsvJ6H5QNQsbuJqZK0brghG7m/Gcc2t6pAt4pN5eOqddQ+93Gy5wS+cjcyIFJJjD7ASqJXLko7ePiwRviSawVZyAXB+GiwTOKm9rztLg7ZUM+D4qI1HtHe5VOoKx5xtjg4xEM/qFeMg3Fb5MV3r4/9y46qFwoVQ3w0eLq2D2BXV/hKLXSVGHTuWGSLFKeRpHNL55HrBMDeyFZZSQt5tRa/pj+WqN5tSUyCunwX9yqhPjTFYPB9sxC5tbu4d6kdRrHZdZto1+euFYw8H59JxTlvceTLd4nUsiEKDlBsY9mr4XZLNs9ds2idMxpgiTN3O0O+TIlOJnI1NQ0nDLcbHmqvmTNqkj0v8DRKyGSMcaJJc8DOo8cqu3OSuxsRnfuxbEwqkvoPX6z5/SgB8+dO/mIO70qOtcvoCld41PahPai3qmAP64d3GJxyjCkI49/PWYsd4SGoGIHsGHEpw3cU9U8wQJwp5VGWAxkt/C1le4OcBBQGszAA6QeZynGF7Zdaw7TTJcbzjVjezBOZY4B0g2MB8ZOeY2CQT+kojA5qQePjbWuIwMp9PV1cid+OU3T7PxbbytWXvmOwHlsb/zdz3IC3h+RRiBZLc5yC0Fq7DNx/rm0QzsxUkqDdLiP9VrLQkV1xhvLbIvSYDBIuWu/9ojPWNml2N4iyD1G56JaIaoNGtW0mXyLHu2+6Rm0leGJM5T5bjw90K5tPq4AMmn8pFDm7rYdP7qhmXXi423lHgHhTXtvm+iE4PwDWcvhW17EGQX5bn0UL5zndyx7Kgxzgt8d8+Lvx4a0/jMoynfXRzezy5yNPVt521xzYlr1LicRDzjHF/oqDbEDwtgF8k+kqzr6fSjyNm4GJLTJ+OjYFaPmU+1JHC3f6T3Fuioh3K1fpxsaQrmV4/JXlfKiYikfeLbqVDptcmttwT2aklbHZOGi0ORWkfs9x4z2YFsEVvkJ31e2lqBktO5vNbx31cFhece2ivfp60WL+7VeMdkXtKk2fc+uvmlyi1dJxSmnaeKhKYgdGHjnRhF/aYwznsnln3RYtG/0DzCwBaj3s5bfrcivqOrv3Bevsy9SeJ/5K1rBKmidftDkr8lus50nD1GiETpsK5+AMLigJ8pCSyeAjpWQ+pUw7dK3pCc5ajimj221rbWpvcbDRx/RdF3ZDMgF+E435qHbzylmenQ0P/3wl8A7+cBmkOTVlbh6pqbZTxhU1w5xkl4Aewbse+vXxGDQ9D2LdwXnWL5rU0ZxtQAuYdRAugExoVFq6G35dR+RtyQuO1ZIkOY6Ueyh+0JIvVtkHLbmwRSpjmSRZOwu2e/5hBc7QJWe6ZDvgyyi+AUvFixLjKIbifuo8UrCkMXmkZiZD9aArVDAOamAPhO34T0ztQ3Jg8uS/huSv+rL3ocM5n0We93evXyzPzcsHBdUwxqHHkCzOeFBY3SsWFDQu45sH6xQ6jnwj3xAtxnl5Me6x08ky+b0Mq6xN0C6afsRFHraPNT9+XrZ7g7nhtVrHMh/Qy8yuomBzr9G5BgAFWPqOclkmgNQH+7RUbP7ekBHi399bYLc8/1vGqpouQn3tPe0taNr7i+mW1zU5HfUj/ZaagpWlCsUMNrhNzBUnFH0+vUShJdS+DLrlqsWPqu0pRfKT6huQE3E60m6dBobQ+jkF84Ejc89/l2aysHTxN+Wjqn31TXPNSBSdcNd3FdMPa4DbiWoMhivG/6eF11XJXqyf7PsB3RNj5jINFayDtAie8K98rE8JqGQEAEa5DnVCZwExh4kVbeqM9Tt/tXkEuQaP0oAKUUyIYwVXnLXnPEr/MH9OHi6sOmkks8j0aL4x0IEiW4atpKU0YeuX/nRrN0rxaI2l9V4cwP70A3qr4G8pPIsErro1CpYEoOt+sLvEuuvr60DS6wCmvGP7mp1nJ/3j5xfHPexzW14YXbITiRXZREW39pUqu7+7/zh4FOxRIATEfCpTDx/+tZ82j7u+0Hj+5PZ3gra/E7T9naDt7wRtfydo+ztB298J2v5O0PZ3gra/E/Qn+50gu9fGyuKdGTSmcgfyycuK7Kt9LugDlabdpR+vswdVfMAVceyiLWoHe8QJ7jEB5IcPmFn6Mktub/Hxe46U/EzBh4z2SRyDdPEtCvPFxh7V2srHVrd8W7y9Ld7eFm9vi7f/H4u3G+0oRvYaSrhdYJZODrhNn21Xz+YEuBZLx1Vlj0Ni48q2/vHL2ekFhswv7e+5TTnyl8lrDAfCvwedN/CHrLkNoH7g5xjb5ggA3hFCcDEULm1gvjyU4DCm/eCFcWW68LCsn0/wZPBf74fBql3+iToMWvKvojm/ae1QRPS5NfICkx3+B9GtBfA=
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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"}}>

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: eJztWFtv2zYU/iuEnhLAl9hJ1s0oiqVx2nnL2iDp5aEIIlqiZTYSqZKUHdfwf985JHWznXQD9lCg7UMj83Ku3znnk9ZBzHSkeG64FMEouGZGcbZgmpg5I28n45MP5xNyrljMhOE0JROtC6bI38zQmBpKZlIRSqL6ALcHeuQd3F/SNGWGKEZjJzDsLVmadu+FXIq+zJngcbe+23V3QxLLqMhgjciZvZbwBRO7SjokmrPoXhNuCE0oF9rY41lpXCZjlpZCNEtZZFhMFkxp8LZDqIjBNlMo4ayz0hiu6SI1Wy5ksozKPVvhA/XKrI5YwqaQhsRsxgXrEC6itIi5SEioeSJYfFdaFe4qljb84FdbtPOSpGwGkSgMWXIztxsLmhYQTFGkadgjFzSaEwiMWqGrYcx1ntJVSBJmnHiwiYJD7pom4Ruwc8x1BB4pOk1ZaLMYCprBI9oWNkARkuUcgt+wB7OBzjp5rTBVYYjmVCTMRVUKA9Zpa1ydwztYn/GkUBS16Dtd5LlUkJ+wF3QCwIbbmMSASnd0zBNuaPrRqnoL4JnE14Ash8gSkHA3pwo8MZDlYPRpHaBbKKPS7C7AQY6I/wLPK/jRroNdxE/s7xl/FNtPFYmSGZzhmry/vkT3FPtScDgfjIwqWCfQAL2MBqN1YFY5WquhDEUCJzMuLplIzDwYDTadgD3QLE/xxNyYXI/6/RiQ2aU57/FEUWF6XPYXw75UCRVc2xD2fxmy4W/xSTSIn53S09PpCYviI3Z61NdMLXjEgk2nCpMvjqej88EdKiurbBM6ZxFEKLJaaxj7SBUa60faiLXK1MWzBCkEKYwVnZm7wXGIW7BQoYHQKGI5YkmkKxSiEWOK+ZLQ7djOaKqfDK7XCUulRlhkosgAOM0l/3haPz4LblvZqA5vbtECnQOkmUadw6Mj/OOrAB9pnqc+SP3PGgO63rVRTj9Dt0I0K/TecCdtG8UV7PfcpHHMXV+5ashwgPsW2ivo+hSXDZdq3+Fi6HBl4l0CnV4yl6kvCCbiXHJf+Y3+gR3GNoZaa7sX7HRA3xsgvRv8t23+Vjk2b1YYg3jMYc82hTWKOPmPealh9SlgSkl1Do0f4YLP44Y9AICnc1jfrpMGYWKJbUoVpsDAzR7xe2Bcw/AlxbzkMCuqJvh4yJo9AssO+zaUEY87NoKVhGbXnvgJDcczCDHod4d92yjFVM28A1qaTSCiAvd3ekAbIj3yB6AINFeFrwlVjEA9SyufLihPcXR5/qEBU1P50HJpX8oHP3DK3wtamLlU/Ct4tB2a0x+6GiagTyH/woEIsLNqtmIElzSLCsXNytKKs5z/xfDxFqfnSwb4VGcFzmlYQa9pgvwj8KyFONpCDixxwbZ5CAoczDFIYN1cItcB1mY5DEoKcJS73tiPnZyuKyRPnvs75DlAM9EJR37afo6BK3gf4Vyh0id5hKUFbQEwSOIisg3jETHfknADcUFW/Mh17ba3Dbmtg3+DGHTQKVNQYYC6Bc9dXPbgl6c2Zx7+FtM7nObsaoL0m2CRYEQd9N1oc3zbt6iwJSckTg3JCnj7mELbVDAfH2A+WrYeOhtJSA6gbzlCbBQ0LxuDnEbssENYL+ltiR0Rf/H5ShYKw9EF414ANwYcNsG2Dqb21yupMopM5s+P73Z9A9akkXzdA5PPqdaleU6StxknessIUkXQFj7G0CkLqqLGvAVYG1zMZNlBaGQ7CLQKjrn1w+D3Op9VSvjreqkNhCaGtrypLoHdcsFhE99AJRY9RJjjX3x5dC6UFNVWnZ0WQF6BpNrhUfMebYkPFRGDCnWs5tASlf0Xr4DiVSqqkr46RIuMjGSqPXNFVDGBd7QfTl9LjiPdsOtYxuTeCReoYUV8qTcIkgb2bBFj4BhVse5afznEgcxSudQunT7S1tqPx+fkwzk5ADwAxCYX716Rm3EXfsGq0za5eUsGvx4NjrunJBvLqJ+NL5ukbGYhZTk1TAIGhBazWhYTYBfiOuwd7aRuuVz2qN3ugct9f1f3LyfnF29uLrp4B5JquElbGLDBKl/9yyIt30dGQKSHJ73j3gDv5lKbjIqGPfgmuPuFoOIX2yXRGHU/v3n8/ObxXXzz8C3VsAfTB29ghm18aa09H/gULIZw0ElBSLc4gftsAvDCIzu8AEboHKoGhazXU6rZe5VuNrjs3vEtWwDqDLGpX50frZmDa08AD/cUyv/6qWRvVO5x7O/7pGPTA1uOefxrd77rDxpPRKD+WlM7fos/lJ1Tjp2WRAgz7K6dWaWNWztkf9OkpK8vkFJQzzdqrnVvuZZ/QOnlllg1ZG/TLmcC/o852nvlOU4CYD8vquNu59ELFVFxpzFEt0DZ/wGyyQ56
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 Qualified Trust Service Provider (QTSP) credential
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-qtsp-credential

---
id: config-digital-wallet-open-id-read-qtsp-credential
title: "Read Qualified Trust Service Provider (QTSP) credential"
description: "Reads the details of 1 Qualified Trust Service Provider (QTSP) signing credential. The wallet reads the details from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call this operation."
sidebar_label: "Read Qualified Trust Service Provider (QTSP) credential"
hide_title: true
hide_table_of_contents: true
api: eJztWVlzG7kR/iuoeZKqeOnwxlG5XNFS8oYbrySvaDspr6oIzoAkVkNgDGAoKSz+93Q3MBc5ipR4a1+sF3IOoNH99d2zjhJhYyMzJ7WKTqJfBU8scwvBEuG4TC3TM3bAPuQ8lTMpEjY2uXXsWpiVjAW7MnolE2HY3ofx9dU+s3KupJqz2IhEKCd52mNjIHbH01Q4Znaoz4xe0gPcDxdG5/MFPRimOk/YNRDkLjdwr5XVxsl8yfaG18N9dno16uHTmZzje64SJhSfpqKit+J56thUzDQseNA5i4EPeC1BrEwYjkL3flO/qXGxI9bKGZ16JpdiORWGIMDbSSXVSM30hOnp7yJ2HWZ1Y3nMFYsXXM0FHO3uhFAsCzhZOu1fxIlS2iPCeA0vdrfQVrDRGZOeiVQ64DRl1hlEtsaEnSC43LGMuwWbawEbdNgDOvLyVKsbIkedqLwdJaD4mIA8k3PpePqZ1HWZCXiHFvHB2WxYUoK9GTd8KYAxG518WUcKbpBGhU8CiyQaFPIG10Z8zSW8jk6cyUVny+pA2oAxMd1mRR+teI5oiMAcLA2X8hWYGBnE6Mz2gAkbL8SSRyfryD1kyLDHNNp0InHPl1mKz958BWG7FfGuTN7CivUWy5d0QZwp+TUXTNJ68BFTyGLBJKf6nmkz50rakr8cRAGL9HaIwAjreuzzAuwEbdQKsGR6twDohel4YsHjTK68XVQiS0UP0HTFvStOR50krTwgQbAaaTuMz7lU1sMVfJS2w+tW7tHJ0Gzr+5Zw2dgsGnt67L3gK688LxDTuStw2CJQOmMpbogYJRpMq/QBnCSAxXOgALjH3IEEEvyAg9NxAwt5HAuLLnErVA3elh0KYwm7FQ9NqB2/FfZxTZahK2wmcMByIdY0OAYn1ai2cE4Xl1IcAqn5IwqaSrIBQXSDU7cyQQJMrj6OWX912PdO3OfJUqo+zyTs7q/h/x/iYZRs+oFCFyhMGOoP+CPEJ//sXudTr4JRMilCTyIyIxCnhKzJa7cuVw0stD6pch+DEPoMLAxi4xR0jeT90ZdmjvTv4HAmZ5W5TzWI4cnaygbaBF5i+hH3EAU6/noqUg2xAk4FambXXMMiFCbVDyLpsVPFcnWr9J2qOW0H1dP04XblFM5DflAQ7dBRTQq0znPnQWGJnM2EgQVbXIItLMHWvBfj3QwCl1ft38fjK3Y8GPSKeOpBgrsQc5vQNiLtDCKjeGbU++H167+KA34cv5oezo4Gg8EBP0r+cjCINjdI0maQfYVFIoeDAf41o+FWQPZpzebkgbM8TR+QfwpQyuFunmUpeiDs7v9ukcR6l0+fXmGjk46YbE9FBiOhk567ZopuI6aAHUwKRSbiSSJ9KL+qUWrLUuNmDWD7kqqAAp0yhT2vVmoURugE3ud2qCGyaAoYNHmoK8qS44maBescktsfVrxDo7xjECRpR26B4fo+/nTtVXDp6a54ignQsgmCO/HRucrmJJvSDOEyS58UdhR3Ob5q09Z/006TAIQqOCkWu4a+o0eRAlgYe2QNYyUEsMkhvwAsEqJdxq290ybpRZsN+MrV6OLbGPTCP83eO1pX6B+O7aGr/lHieXooECbCX3TyDIqnVcqkEAybCvZqJRpyGYO434YSUgDvwaxja5S4MfwBY6ATS9say5osDysy6DOQancY7mACnnIrfjhmXjckgrQ2F+bs4mlYziAJwfNc2kUjQ8IhtdM9PSINuRLOvcjR054mf02rmaLlLZQ9SQce2gLIDjFa9yiVnBT1xwkdCBJxiA4yeQfF0rO4NK6NHtGQ7oGBpUidVHTH+mmq55Can0Vzs21GT4JR3T3iEFCBfZs/8HSuv8EPqhiOhAzkkaX1lUlRXdo8yyC2W++/uVk9IyCcpylex4zWF6IDNSKSijp0EpL+nCqWJo33Qs2hwKn2en+UgZP/z7A9C6jHJXT+EhvJZ7ByUbqYLeCqgVQra7Czp0oNOD2o9dN45KZeen3ZLkRuaEGocIElvDv2ldSzy6I6eWGMNkOM3h1/XTPFCEq2bYNrGlW1uw2csioEBjct5Ft0UhWSP0LhJ1WW41QizAgInR3LLEcufkgTCuq4mOdASU0tclhkxAzaxSSUSL5ljnYBPfiOAf2oMKODj/9bJDvQvPqubW0E5xmFQzSoxcHT6ZgtjCg/QzyDjEAzrVNqm+HyBoc/P9JMAQsheoJS8zkOv6IwMmN+Zsb2aGp2dvxpuA8HAAX2C1d8LpYIO2wDLhcaB25zQVjheOwkqjXviafX9Z1BH6BUMulDYOsuS0J9nFH11/V52yai+mJVjOS2E9VSB+FhXW5S7CSdy+xJv5/Auy7PZE/ODVeuJ3XLuAvSVJLHlOgeIfMUBQjUcxzqPbLd+tfbjNxUWrlG4/Q2VeimSov+wSM98mnwCzL23eq2GN80qtx6Z1PMfxt0JsVAqhgwQIU+k/cQo/xMxvPIJmwP4prvtJyBvp4wyHgs9jtM9Oa9LbInLGx8g+MMhAMHRm8nlBTrVriO/JzrXWgrop8/j3dlq83AqKEp2POUAs+YzhpMsBJBigiIoT8sKr0d9Rah08jQZ2No4TGFFoghEnUbSou/VfosVSJ/qh41DaFuQ1vSlJuKeTo2NLHGaICFNv6jd/B6Pebdkeatn6DOm0kaCA9rs+MRFOgcOitwXfLb0T4Nc9o3XlEbFo4off1qHzlyOoYuHA0Hkhlalf8cYcO0x0NLoyDqCTpsodMwOVrhCQ8s+H5jtJ1bshgHy7hJbJfklYADm0EXb706A9LE7eejIfs0ZHtgD2Bio/PxO3Z91oU7eOpPG11fsoPXg4Oj7iu2PNNxf3n2vl7m+G6IRuaQIgT0+ajVwpnAdgHXw95gR3V3d3c9Tq97IHI/7LX996Ph+cX1eRf3bKpxTqVOBCvRcV5qD0hjJPNqPxwcHveOegfUBmvrIA7W+MGh0LO/T8X1ydFWqV/mxpePYN/PR7AQzfDDST9LOaSPTbDqdcjNX6LVoR9eAsZoNY387L+jQYaOqNer5Wh4gFka/k4a38Ugo4FwDgmv1zh++GjSzQYfQ1VrqODA3tZIP6TEVC4tXlcT3UcNd+/XULbtsz/pk1orfkVSVpiRKYXCXRSa4eZXws1N2Rb9j7K+fIB7+QD38gHu5QPcn/gBrjXY+aC28xmuDHvYCfk1p6SU2rudFnxTbxB/Osd6nodiv2p0bqnRCRcYM1vD7XbP41nAX2Sodcsb9COw1Lflcv/m0Q1ll+BXIx445/oPOofOMA==
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 Qualified Trust Service Provider (QTSP) credential</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management/qtsp/{credentialId}"}></MethodEndpoint>



Reads the details of 1 Qualified Trust Service Provider (QTSP) signing credential. The wallet reads the details from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call this operation.

The QTSP controls the members of the `credentialInfo` object, so the members can change between providers.

You cannot read a credential whose ID is the literal string `credentials`. That path goes to the list QTSP credentials 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={{"name":"credentialId","in":"path","required":true,"description":"ID of the QTSP signing credential. Use the list QTSP credentials operation to get the available IDs.","schema":{"type":"string"},"example":"<qtsp-credential-id>"}}></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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

QTSP credential read 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"}>credentialInfo</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 `credentials/info` response of the Qualified Trust Service Provider (QTSP). The wallet sends the response of the QTSP without a change, so the QTSP controls the members of this object. The members below are the usual members of a Cloud Signature Consortium (CSC) response. The value is `null` when the QTSP sends no information.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>OTP</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"presence"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Tells you if the QTSP needs a one time password."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"presence":{"type":"string","description":"Tells you if the QTSP needs a one time password."}}}} 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"}>PIN</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"format"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Format of the PIN."}}></SchemaItem><SchemaItem collapsible={false} name={"presence"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Tells you if the QTSP needs a PIN."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"format":{"type":"string","description":"Format of the PIN."},"presence":{"type":"string","description":"Tells you if the QTSP needs a PIN."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"authMode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Authentication mode of the 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"}>cert</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"certificates"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Certificate chain of the credential, in base64 format."}}></SchemaItem><SchemaItem collapsible={false} name={"issuerDN"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Distinguished name of the certificate issuer."}}></SchemaItem><SchemaItem collapsible={false} name={"serialNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Serial number of the certificate."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the certificate."}}></SchemaItem><SchemaItem collapsible={false} name={"subjectDN"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Distinguished name of the certificate subject."}}></SchemaItem><SchemaItem collapsible={false} name={"validFrom"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Start of the certificate validity period."}}></SchemaItem><SchemaItem collapsible={false} name={"validTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"End of the certificate validity period."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"certificates":{"type":"array","items":{"type":"string"},"description":"Certificate chain of the credential, in base64 format."},"issuerDN":{"type":"string","description":"Distinguished name of the certificate issuer."},"serialNumber":{"type":"string","description":"Serial number of the certificate."},"status":{"type":"string","description":"Status of the certificate."},"subjectDN":{"type":"string","description":"Distinguished name of the certificate subject."},"validFrom":{"type":"string","description":"Start of the certificate validity period."},"validTo":{"type":"string","description":"End of the certificate validity period."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the 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"}>key</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"algo"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"Signature algorithms that the key supports."}}></SchemaItem><SchemaItem collapsible={false} name={"curve"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Elliptic curve of the key."}}></SchemaItem><SchemaItem collapsible={false} name={"len"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Length of the key, in bits."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the key."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"properties":{"algo":{"type":"array","items":{"type":"string"},"description":"Signature algorithms that the key supports."},"curve":{"type":"string","description":"Elliptic curve of the key."},"len":{"type":"integer","description":"Length of the key, in bits."},"status":{"type":"string","description":"Status of the key."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"multisign"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of signatures that the credential can make in 1 operation."}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"additionalProperties":true,"description":"The `credentials/info` response of the Qualified Trust Service Provider (QTSP). The wallet sends the response of the QTSP without a change, so the QTSP controls the members of this object. The members below are the usual members of a Cloud Signature Consortium (CSC) response. The value is `null` when the QTSP sends no information.","properties":{"OTP":{"type":"object","additionalProperties":true,"properties":{"presence":{"type":"string","description":"Tells you if the QTSP needs a one time password."}}},"PIN":{"type":"object","additionalProperties":true,"properties":{"format":{"type":"string","description":"Format of the PIN."},"presence":{"type":"string","description":"Tells you if the QTSP needs a PIN."}}},"authMode":{"type":"string","description":"Authentication mode of the credential."},"cert":{"type":"object","additionalProperties":true,"properties":{"certificates":{"type":"array","items":{"type":"string"},"description":"Certificate chain of the credential, in base64 format."},"issuerDN":{"type":"string","description":"Distinguished name of the certificate issuer."},"serialNumber":{"type":"string","description":"Serial number of the certificate."},"status":{"type":"string","description":"Status of the certificate."},"subjectDN":{"type":"string","description":"Distinguished name of the certificate subject."},"validFrom":{"type":"string","description":"Start of the certificate validity period."},"validTo":{"type":"string","description":"End of the certificate validity period."}}},"description":{"type":"string","description":"Description of the credential."},"key":{"type":"object","additionalProperties":true,"properties":{"algo":{"type":"array","items":{"type":"string"},"description":"Signature algorithms that the key supports."},"curve":{"type":"string","description":"Elliptic curve of the key."},"len":{"type":"integer","description":"Length of the key, in bits."},"status":{"type":"string","description":"Status of the key."}}},"multisign":{"type":"integer","description":"Number of signatures that the credential can make in 1 operation."}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialInfo\": {\n    \"OTP\": {\n      \"presence\": \"string\"\n    },\n    \"PIN\": {\n      \"format\": \"string\",\n      \"presence\": \"string\"\n    },\n    \"authMode\": \"string\",\n    \"cert\": {\n      \"certificates\": [\n        \"string\"\n      ],\n      \"issuerDN\": \"string\",\n      \"serialNumber\": \"string\",\n      \"status\": \"string\",\n      \"subjectDN\": \"string\",\n      \"validFrom\": \"string\",\n      \"validTo\": \"string\"\n    },\n    \"description\": \"string\",\n    \"key\": {\n      \"algo\": [\n        \"string\"\n      ],\n      \"curve\": \"string\",\n      \"len\": 0,\n      \"status\": \"string\"\n    },\n    \"multisign\": 0\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The QTSP vault is not configured, or the QTSP 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

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} 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 secure vault
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-read-secure-vault

---
id: config-digital-wallet-open-id-read-secure-vault
title: "Read secure vault"
description: "Reads the current secure vault configuration of the organisation. The response shows each vault and tells you if it is enabled. The service does not send a field that has no value."
sidebar_label: "Read secure vault"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv2zgW/iuEnlLAlu0k3e0GRbGp3ZnxbrfJ1Em6QKeAaYm2OZFJlaTseI389z3nUJIl2U48DzMvzUsii+S5fudGbYJY2MjI1Emtgovgs+CxZW4uWJQZI5RjVsCTYEueJY5FWk3lLDMctzM9pZ3azLiSlt6F7AbeGGFTraxgdq5XlgkezXMCXMXMiSSxbK0zJqdMOiZhh+KTRMT+tBVmKSPBYi0sUxpFgFOcTaVI4PScOzbnuAI0k0yEv6nfVI3rXCe5EtZpI+JCeHgEjSQH7lKxKBHcgDAPrsVWcwkiShUlGdiDjYE+vNEmvcOTIZ2/5tautInHpMT4u7NpGCUSKI4EkHbjkF0b7UTkiHUpDfe6ppW1iiRe5V9vRtcsA8XZ9fATGoTsqpI1mh9oe61dxThKLGE3WsayCY/ud61gHXeZBZfFwnsKyOpU5L6DH+PTbm/cIgvDY3cMJIJWUG4ZxoAH7/CBnEnHky88SYS7SgWsIVBGBA0yERxMueEL4YSxwcXXTQNXV/TAk5DdKvk9E0ySAcClpoCRBbNO9EMNTsxpNAubauMVMAIOWxeyL3OhyK4EDlqbg0jCtGpmMpnKjbnVXHkfaIW+L7grkD3eK0PLG1/aFuMzLpX1jliRMfxxWN4rPQIFzVs9t4DH2uFmAH0UfCnovVeI6cwVdmgQKJ1eqpuHb2kND6JVYSyeAQWwe8QdaCDdHMJqAmEAG3kUCQtn9b1QFfPuOaHY5fWQ3Yt13dSO3wt72JNToxe0mh8m48iZggCtSQwBodFtOZ82bo1AW/QbP+CgiSQMCKILpjooBCkwvr69YZ3laceDu8PjhVQdnko43dnA/3+L9TB+7OQU2kBhzNB/IB9ZfPzf9iibeBcMIR/k8RqL1Ai0U0xoKoOu1KtiLESfVBmqrsn0KSAMEtEEfI3kPesrM0P6K2COubKE+0SDGp6s3WJgn8KLDGAnHqQF2vQ8EYlWM+QK1MwuXPNNqEyi15iSLxXL1L3SK1UJ2ha6px7D+51TBA/FQUG0RazqFGifl84bhcVyOhVUg+pSAhYWgDUfxfhrymXiXfvLzc01O+92Q8hHEvOONxL8Qo/A77pp4T0mFAnpOLiYQjYWrcBGc7HgwcUmcOsUj1hnpJoFj61APPBFmuC7v7158w/R4+fR68np9Kzb7fb4Wfz3Xjd4/IYkfQa2SARyLP6rZ8PR4ZqKEcxsRsE4zZJkjapQrlIOCfE0TTAYYW/nd4vUNrsi68nvUGrgYJ1tPy/pO1WcCnS10B8oxFCJMoNhuC1geVWmDCMbhRmLgsHE66Q3Rr2sPi/wL8V+drdrql3yeRdRoTvRGqq82iE8or5k7Ewmxl52BNOWnfdMpTEJKt4noAAcaNMtGMljqwmYJk/c6RMDVrOmapU8m+u2RRsxamN7EBRsi2bkebbFzj/M9a1nm+bn35W8L+MYIG6fZ/2eY/vjdxe1rikBYgySY43z3LnUXnQ6Hor5+zDSi1KET2BGm/LoCLOXW7GANLjX2VIdCB4fq0nhawmqb/BezgwHa+kj4St/xu2h1JCvFJ9tG9E/F8Zbtk/CGE89pSw2uM/r+GvGE0zgMbsxWDpGec6AVngpsQE5wd721Z+tMzXQR0VtZKNbkxwJ3tvPHwvg9kf9IiHuRysQrmIVfyNe/YgwPCJS+7STDQcUqqTRk/GJDmp78m3p47M6jxzNMB8x/jhTf5AYY3IaDo5MgqChETPoSQQOZ1S4Cx/u44a0SwXLwnOMRYFR7j1SzEK7Cduq1avoTiA3AJsQ4Ot800YVbCtbAd+cUoVCOVjsNVS5r1TARpepvIPGTfri/YyLAHXYMC/9gVLO8bJHfSeu98JueB52/Vi6PC3fn4ansEK9kFDZAuN72YMfy9PgW6289J5MevHkPcyXIj4y6Q244xOMnQmd+mtSXryX6ZOZ4KDGjYVGz9IsAnmebJoJyACdvEUHtfAX9KWo4NHNXE08Y7TpwyiPiuDzoGIV8GbTJw3zlqe3BpYgxYxa49IwIODjHvJ7QLoFz3toV6VKYWwp539AE2lfd9xNY9AtZgIINAkDAQ345VTdmBfQfU1b9n5gW94qzNHayP+JeMc0r39omA2BHzTkSd5YMmLTsBEcomFHujVdVV3SyA+PkO42wXu6D7kEA9Mb1JrP8E4ryK/BmL8HYyd0EzY4v+u/AgZAgf2H2rwFmh2OgZRzjZdoM+Hvx5BiULl4iD29tgd9B0ypZNy5F+v2YksIZUVN9t2qDcRC54rCvgzbmrIdiWGtzVMZ+nwF7WCA2jWGA6PjLKJwPEDmOQojMA7W1APHrV9uCvJt64ERAtHjp/BDCQR/F3Nolr/MY4CAvVMoymumejdDg60v7nlrMK7RGRcXZ8VFSGrEVD4UfcrYy8jG7AQSlL+DcIbLhGyAY8arFhPhLGyQvWD5wbd47YLmwIutd+MQe4Iq4jaBv4/7SZsFh+gN/vXlZle3yl0dwwGtEM9TymXGZqEmBCstSNFPZZYOBGVko9+oG5Bqqos0wiNKI5AvJPrWZmmqjfvn1p+lS8rRYwcIVQwdHJNSPzRYvGHQGPlgYYn/MRJq3xx86FHPCr0UDCBYvVm/csM/tDbjCiaRkyuK0eErapD2H7yGEbVkUcY1jC14a68j7e/poSohqnyrYPNq5k1LV1YSWIoWfX7wN1xL5LBmeZzXPkBklhDjYBs3sW2TvhLswKYJdjjkztzSJO2Xsz6767MTwANAbPjh5ic2GrThF7z13IajK9Z70+2dtV+zxUBHncXgY+2mhiBlsZhCORDKUp4uggmwC3aFjnHHdavVKuS0HILKnfys7Xwc9j98Gn1o4xlwqpMuqWGAjBXrKCu9h81n0fkGp93T8/As7OHZVFsHOa8iz2e6B6tcSTWDoFLhXr5a/fBfrfL0hXbppAnHe5wcxpu88H7FuaeVf9BCMNWKr//wBeUXHhoFGGrVHOCJFDYbHDJuTfL4iK+/Z8JQ24C3UoYyiW8iilJFFRsw5meb/IL5IIpfvpG9fCN7+Ub28o3sL/xGtjdt3mMPvvuljMoWLNAQ4PdcklMqazuT5mN1Dvr5A7ayPO9ztz3+PfX4+QPmzGJJrSu0m+2+FwH/okB7j7zFOAKkviu3+5WDB8oG2e9Ge+BNzv8Bzmtk3A==
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 secure vault</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-management"}></MethodEndpoint>



Reads the current secure vault configuration of the organisation. The response shows each vault and tells you if it is enabled. The service does not send a field that has no value.

The response holds the stored vault credentials in clear text, which includes `hashicorpVault.vaultPassword` and `qtsp.clientSecret`. Protect the response as you protect the credentials. The QTSP user PIN is the only secret that the service never sends back.

The response status code of this operation is `201`, not `200`.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Secure vault configuration read 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"}>hashicorpVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Hashicorp Vault configuration.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the Hashicorp vault is enabled.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"vaultUsername"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User name for Hashicorp Vault authentication.","example":"vault-user"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultPassword"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Password for Hashicorp Vault authentication.","example":"<vault-password>"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the Hashicorp Vault server.","example":"https://vault.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultNamespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace in Hashicorp Vault.","example":"admin"}}></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"}>igrantioVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

iGrant.io managed vault configuration.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the iGrant.io vault is enabled.","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"}>qtsp</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Qualified Trust Service Provider (QTSP) configuration.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the QTSP vault is enabled.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cscUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC service.","example":"https://csc.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client ID for QTSP authentication.","example":"<qtsp-client-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client secret for QTSP authentication.","example":"<qtsp-client-secret>"}}></SchemaItem><SchemaItem collapsible={false} name={"userID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID registered with the QTSP.","example":"<qtsp-user-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the QTSP signing credential that is in use. Set this value with the configure QTSP credential operation.","example":"<qtsp-credential-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"cscApiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"CSC API version in use. `v1` is CSC 1.0.4.0 and `v2` is CSC 2.2.0.0.","enum":["v1","v2"],"example":"v1"}}></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"}>dbBackedVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Database backed vault configuration.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when the database backed vault is enabled.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"hashicorpVault\": {\n    \"enabled\": false,\n    \"vaultUsername\": \"vault-user\",\n    \"vaultPassword\": \"<vault-password>\",\n    \"vaultAddress\": \"https://vault.example.com\",\n    \"vaultNamespace\": \"admin\"\n  },\n  \"igrantioVault\": {\n    \"enabled\": true\n  },\n  \"qtsp\": {\n    \"enabled\": false,\n    \"cscUrl\": \"https://csc.example.com/csc\",\n    \"clientId\": \"<qtsp-client-id>\",\n    \"clientSecret\": \"<qtsp-client-secret>\",\n    \"userID\": \"<qtsp-user-id>\",\n    \"credentialId\": \"<qtsp-credential-id>\",\n    \"cscApiVersion\": \"v1\"\n  },\n  \"dbBackedVault\": {\n    \"enabled\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is not valid, 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>
      

---

# Update secure vault
Source: https://docs.igrant.io/docs/openid4vc-api/config-digital-wallet-open-id-update-secure-vault

---
id: config-digital-wallet-open-id-update-secure-vault
title: "Update secure vault"
description: "Updates the secure vaults that hold the cryptographic keys for OID4VCI and OpenID4VP operations. Send the full configuration. The iGrant.io vault must stay enabled. If you enable the Hashicorp vault, you must give the username, the password, the address and the namespace. If you enable the QTSP vault, you must give the CSC URL, the client ID, the client secret and the user ID."
sidebar_label: "Update secure vault"
hide_title: true
hide_table_of_contents: true
api: eJztWntvG7kR/yrE/mUDetvXpkYQ1JFzPbVp4ovspEASQNQuJfG8Wm5IrmTV8HfvzJD71Mr2pUhR4IwAzj7I4bznN7O6CyJhQi1TK1USnAXXacStMMyuBDMizLRgG57FFp9wy1YqjuhdqHepVUvN05UM2Y3YGbZQmr2fXJx+HE8YTyL2PhUJ3l4ylQrN8QDTY1OROAqLLI5ZqJKFXGbubY9dwXP5N80T25PKHczWmbHMWL5jIuHzWEQ9Nlmwncr8PRH7hRvgQ+nUberQe9q5lBu3JDNCJ3wtOnSXcmO2SkfujkeRFsYQ23iP60zKQ9F21q9X08vDx4ynY3b94a2jG8ZSJJZNLmq3oFctbHEYMgZLel+SL8kVqV1vZChQn1uuI8NUEu9o5cxrYMYWMV8ytWDcK8kZh5tiyRlb8NiIWYcZxaRlYACTm9UqLSKwoIiAGwnLkBJRIGJgBgUWFak3dG0ZzyUvFjgGctvkQoA6U7A3nsZtZsDQkXDHSFP6A4Ob2WgwBDYTZfFyMAMSQScolkwi8ErnJhdyKS2PP/E4Fpa8K3LuOiVH/YiMwFYtvmXC2Ncq2gVndw3/fie2Nb+ueyD5MAql9JIn0ji39DQlaCI4szoTHWTIglaQPk/TWIa0sv+bwUPuAhOuxJrjld2lAo5V899EiMzVuZmCG4BSWjiBSHnDw5V/hZblScP+Llxyb3GvTMUk5DbblUhcuKHHoLpRgBnKlGpUspXCIKOrPIKcGh9lvYy4jwf0KG4tRlyM2YGcji/F/rlepMqBc6ViwZNWZVnlBcCrw/GPx4hbvk5jIEiBcN8J6M21zwKV84zVMlnuHYcrKRGQME1xeQbHQliEPnN98A7iFF4aqqbxgiXHSxcjP8g5u/QZ6XHO8pU/grGXjrM8Pb4q2Dt3KfJx7l5DoikSKkW82GMSnVbo383cytrUnPX7zsb+eS9U64LLd3nifpzPYimTSZPB380Zj9YyCe7vq5nic+HbX+G5XGJZk+qJ4VVWwTVPIHCitiSBGQAYcm/ggsdbDoWYhxarEdYXrE8hTzC5RpDOMFyk/VFB2KjcLj/5bAzlSEIFka6aGgQBM1ehaopEsg9p8Zs16ePK+zXjsVxIUNqVxuI89TnyUquNjCCsj7CGH7fkLC3Wygr2rSAgYjhAqwRAjpHLBGqZpiSrVbZcuYIfqyxi0/wlG0PyVqDZbM2OAAwcs/PLyY/SeAlFWjNeaMJrHT8xZAG05OGKGMbXle+OUTi7GqF4j1HqINDkCVlunGMnMgxJ+t/mNvSeruOgK11uc3dTQmRP5skDuB/Cl6NNvGF5mFw8sVKBnrRYSgM1Fw+WdlV4yHcyhMcXajLheSo/Cm2kQziP6AkcCNyebdwG9Fqg1mPAKZtthjNSHS4a9ga9096ActVsMypfjHojeDWoY5wMISztJzkwk0SKkKNxXQXIA1EbRyROkq0xfWyGcLMZBV9r9Xf4YLKO5q95eCOiJybrC275HGNoTrseTdWInR1So8ZJOoS2JVzLIk/sR+WMqI3ZlvRxUD2NFw3g2Kx0PmfDNtyYcg1lF3wUBPrcxObv6YLH4CeJhKrBJHUeYFGdZyYDjjJXtzV87r3LY3dQsi85PfYp95LSPVaCQwHo+P7WuZXOEmeNSl/iTEIw/9bmpyMajFp56Lj+SZoO40suE2OrJs3bq1bu0fXRhav71nBZ29zoSNhbwX2/6QRiKrO5HhoE9vpKDTtMVRuVTgGVVclmwiUSzuaCa1jIwxBRnVU3Iqmot2VHQvEP7l1XteU3eRfapouFVmt66zeTcqCyKld0C46pRQWz+XO6uDQEadFu/ICB5tL327gYVHWQCRJgdnl9xfqbUd9FcZ8AXp+nEnb37+D/f4jdJLrvewpdoADpFOwH/JHGZ//qTrO5M8HEpVqKPpFqgXqKXG+Rt8SFXBVloffJJEPRFak+BQ+D1nsOtkby7uj3eon0t3B4DV7NFYjhyJrSB9oEpgGGuIXa0XHXcxGrZImnAjW9765+EQoTqx1OZM4TliU3idomlaDtoHnqMdxunDx4KA5yoh06qk6B1jnunFIA1S4WUPGgKNe5BF9Yg6+5KMY7xJ/OtL9cXV2y08EAc57EvOOUBHeuMQzqqq11/5QaO/v9va+D99Ua86cXL/4ihvw0/Gk+WpwMBoMhP4n+PBwE91+RpJuPUGIfDYb7k4ppdUqR0ZwDck9GEYizsx3y/91ziHplMZUBSrmYa813qBY4DZN/Pvyo8zm5KNq86qQQ8gWYc5sPhtonK+TuGx5jrofKjgf52p6osq3JZ0toLyvW1R5UgvhLst0Dyptc9NjMg46WPqXDZqPy5d4kcXZSvqyO/man5fPDNdWBkGFn1DnpnH6t+gc8PKWqCA99mIJgeAe+iSI+2ba1Mq210mMVCTwcry8qegG/e9gPyt1tKi5YBwbvW8i3wMIyGl5zyORJCqmrwACBl75uumrTOFfRLs8L4CbSj2ubI2JY4btbWAAm4a2zPYlIC1oR4McSumpqffgH1vp1gkVcaflvEe2p5qc/tENOEj/HdFMrRsc0dASbKIdKuyNge04AAS4h5O+C14SezkHB9ASl5ktEwIEfaTM302ZH+TeT8TEcABTYP2n6s0a1wzbgcqVwIA5so644UgwqMCVy9LoOd/RBlYmM+oBZuuuSEPKKkrRh8AuxVl5QWJfh9KBo6SN41wXo03MIH+IvQOkaw0mtoiykgDtA5jEKU1AOGOvQduNeNxn5Wlpgio7o/Ce3Q1nT3IMDlf/cxwA59l5RKUBpo90vi5ivg7ManVkOs3PYBAhwIW/zLn3meGQzdpTg7AkJWA1ohXSAA8rjDhO9Za9B9oz5jS8RpKE6EAa/glYenLHqcXeBQ+8/K73mEL3B3z9d7ctWQfb0cSxnz1HyPCO+rjHBCg1S9FNPShuCIrLRbtRsY574UH6beZNHYtu3h6LV9YCrMbuvzs/3xuf7M+zmCPuBQfL+HDmf7baMcAsuaWxZTieb3OdzuAeHY9XZ2P6oqjmpah8alTOj5gxnb4RDI5CWSUedd7SbTBYqT/88dIugv0R5TJamStu/lnFYhFJRo/cCuBr7B6feqRvVGqjleclmEv/HDOZczwebS5kExUA46BNo0jGufLacGJPxBBqqI/95+rjyfbq58RJcpDiiyMeXx8iRVaGKjR/lYDbIP7o5UOtCghoTCUeKDn0ud33MBk/YMZ+fa19VM0ORbmEZfu7tkrwS9MAWsdoaF4Ze08Ttp5Mx+zhmRxDHkBomb65+ZtOLLtzBU3faZPqeDV8Mhifdn9j6QoX99cXbyplIBVKBQRAEZVxAH4JWzZMg+D3oddQb7Jluu932OL3ugch9v9f0307Gb95N33RxDxjVShvXfICUFakwK6yHgVa44mgwOu2d9MghU2Us1KoKP+4bb+2rbTN9VbDJ8y8Ynn/B8H/xCwZf/nB+2E9j7kpI5j7HOOD2GcfSHf/jBnTpGnhzP4IA+AYXDQAHWGcFYYIU7u6w74Tqcn+Pj6G6aoKdWMe0dF07gtAc6hDi871SUZ8OxtLzRPZ5Ivs8kX2eyP4PJ7KtafMGe7j9uSw1XfCCmki3ZuxyV/cKyZQr9uYV5Y5zMuODa6udN3ghrJ37H5etaTQRaL7FMTH8PQu+wD/K3QQXaByCz++CmCfLDFI4rHFkEVxz36KV7ekNtaf+AtN1/irZVZhsdqpOFvyLkrVueYkhDEHyqlju3hzcUPR2bjWaAgeW/wEQ99f+
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 secure vault</h1>

<MethodEndpoint method={"put"} path={"/v2/config/digital-wallet/openid/key-management"}></MethodEndpoint>



Updates the secure vaults that hold the cryptographic keys for OID4VCI and OpenID4VP operations. Send the full configuration. The iGrant.io vault must stay enabled. If you enable the Hashicorp vault, you must give the username, the password, the address and the namespace. If you enable the QTSP vault, you must give the CSC URL, the client ID, the client secret and the user ID.

The service forwards only the `enabled` flag of a vault that has `enabled: false`, so it erases the stored credentials of that vault. To keep the credentials of a vault, keep the vault enabled.

The response status code of this operation is `201`, not `200`.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 secure vault configuration for the 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"}>hashicorpVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Hashicorp Vault configuration for external key storage.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the Hashicorp vault.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"vaultUsername"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User name for Hashicorp Vault authentication. Required when `enabled` is `true`.","example":"vault-user"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultPassword"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Password for Hashicorp Vault authentication. Required when `enabled` is `true`.","example":"<vault-password>"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base address of the Hashicorp Vault server. Required when `enabled` is `true`.","example":"https://vault.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"vaultNamespace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Namespace in Hashicorp Vault. Required when `enabled` is `true`.","example":"admin"}}></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"}>igrantioVault</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

iGrant.io managed vault configuration. This vault is always active and you cannot disable it.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the iGrant.io vault. The request fails if you send `false`.","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"}>qtsp</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Qualified Trust Service Provider (QTSP) configuration for remote qualified electronic signatures through the Cloud Signature Consortium (CSC) API.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the QTSP vault.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cscUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Base URL of the CSC service. Required when `enabled` is `true`.","example":"https://csc.example.com/csc"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client ID for QTSP authentication. Required when `enabled` is `true`.","example":"<qtsp-client-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"clientSecret"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client secret for QTSP authentication. Required when `enabled` is `true`.","example":"<qtsp-client-secret>"}}></SchemaItem><SchemaItem collapsible={false} name={"userID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User ID registered with the QTSP. Required when `enabled` is `true`.","example":"<qtsp-user-id>"}}></SchemaItem><SchemaItem collapsible={false} name={"cscApiVersion"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`v1`, `v2`]"} schema={{"type":"string","description":"CSC API version to use. Use `v1` for CSC 1.0.4.0 and `v2` for CSC 2.2.0.0. The service uses `v1` when you do not send this field.","enum":["v1","v2"],"example":"v1"}}></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"}>dbBackedVault</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Database backed vault configuration. This vault keeps the keys in the wallet database.

</div><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to `true` to enable the database backed vault.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Secure vault 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={false} name={"secureVault"} required={false} schemaName={"integer[]"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`]"} schema={{"type":"array","nullable":true,"description":"IDs of the vaults that are now enabled for the organisation. The value is `null` when no vault is enabled.","items":{"type":"integer","description":"Secure vault ID. `1` for the iGrant.io vault, `2` for the Hashicorp vault, `3` for the QTSP vault, `4` for the database backed vault.","enum":[1,2,3,4]},"example":[1,4]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"secureVault\": [\n    1,\n    4\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request body is not valid, the iGrant.io vault is disabled, or a vault configuration is incomplete.

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

---

# 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 in the secure vault. The wallet then adds the chain as the `x5c` value of the key."
sidebar_label: "Upload certificate chain"
hide_title: true
hide_table_of_contents: true
api: eJztWG1z2zYS/isYfrJn9G47cTyZzDly0uourTW1nXQm9UQQCUqoSYAFQNs6j/777S4ovkhUk+tM+6H1J1EkdrH77LO7WDwFkbChkZmTWgVnwU2WaB5ZxlkojJOxDLkTLFxyqRhXEUukurNMOuY0rLkTKwYf3FIwK8LcCHbP88T12DW8eeBJIhx+BNEIdOKyQpP/M3s8CWcgkuSC6ZhegcbeL+oXhQpimQiW5taxuWA31++7p8yJR4c7Tt/9wGJtUg57TXPahCWCxw2rY2ms63gDcIFUTphURJJcqhba2hqjtat/865YYe5lCF9FnFvhjSfrHlAO0FjqhEDLjLxH7eBGx39stSzSoETBTqCNVky7o5MXDBC8F4VcMwDSMvGYSSMipg1JrgBaQE5GHXyzESF0rVwo7jAa0u8SamNE6ADYoBPoTBiO0Z5EEO9Qq1guLuRCOp58oohdZgK+eSKMKxvGqBvkM254KgBJG5x9ftqmj5K/QTBlJBTKCVOLK8hKXJNxt4RnBVrgH3wAQzqBEb/l6F9w5kwuOoENlyLlwdlT4FYZLrTOSLUI1uvO9qaX9MCTHtu7vQXuzvUjQLXgSlryHymM+AOPYA1AhSYIC4z6hGiudA5xB8rTt6XgkTCdguoFG3LlqVBCukkGQJWYWuyOrkatNqBCDowGCvIF4Gs9lYvUIXH43Go9ZiMGty6XYvjrwqIh02MfBL/3jPMOMZ27DQ5bCso0rMjPKYlLNJhWycpTD8HiOWaR84R9kG4JhJwLbmAhD0NhQVbfCVWDt0VCsfPpxKdPHWrH74q0a8UiNjqlr4UwgQNZoI1oWAzZrDFsxT5dXBqCtxg3vidAc0kcIAojVHuNIAdm05tr1r8f9X1i9XmUStXnmQTp/hP8/gf5vu4XGrqgYcYwfmAfIT77uXuVz30IJtEMUxh3jEQGKQw4RcQmH926XzWwkH1S5ei6JugzYBgUwjnEGtX7rS/NAvU/wOZMxhXd5xrc8GptxYE2h6k0i0eJRbYo04lWC9wVtJldum5qOTiT6JWIeuxcsVzdKf2gaknbwfA0c7g9OJvkoTzYKO3QVk0NtM5b50FhkYxjYWDBlpXAhRS45rMY/8VcJj60319fT9nxYNDbFDIPUlXKmtA2alrME/t7Ra0TiEeeZgm+e3F6+koM+XF4Mh/FR4PBYMiPopfDQbC+9SqhRr3V0QrVNAshdUVsS+Sv70nkyHYr77UUXKpZyqHWFHq4hDrv+thjuxF3ZPOO9Xr+K7QV7AkGS6CTwuLX2nZf0JxdfzuBb97wBtKLG+wNf9AVTF3sr51me0cOUC/XpsyP6jyBfEGdzY7dw+ZSw+Xzrie367VfYzOtrHd3NBjshmK8Y2dODRX7QE7VMM6TZIWBqAHPsyxBGdDR/9Wiom9HHRz4IqM2rL+9RXu023Gu0geNruh6FI/4q2F4/HJ+Gh2LFzEfhCfRSzE8nb8aHQN/kdz1w9aXUOfe28JOjNuC8qhp6I95OvfW1cU3LbaEsyR0adIR7Ph44r4OxdX3590haIONgAaq7Jnb5zXkFptzK14c5ybZHDwbKLwuP3ftkg+7ldI3gTfni4Uj3rfZhGfBP8EqUNu0a4vtBYNaw+URrTlyS4lQ9AlwC/8d+0z4ZkLXNxfGaDPWkUAH8PmiBgsUvt8nfyXdxqsSEDBw3aK+JSgVhm85HCVUBr2zPPkGa18GmpG7LnJocoEtKZXWgqpONSsUfYoO7TjA1D61jg9/YHLYNzTQjPDV8SDYjefwHxzPG4XnU23kf0W0A83JP5rqE2y1MHHRkRNqNG2zhREI0Z2AdCsaFM/p7AuPtzjBvaXB4BwApjfoNV/gRBkUsyjzwyg7oHH04vjj+BA2AA3sB674QqQIO4iBlUuNk2ymLYGF0+VZUDuCR15h15+p+4ClklEfUqyblprwr+0/3fnDeS2JumEx9npP22beC5HqAghYB7UWj4bOZfas34/gWxdO/T25MFy5ntTB7vw6NTrKQzp/7lHzNQ1XAB4Ec5+49Z+3DbmtInSFRPX82sSpJIofWvYdes+LHCHi73Szch6rJj2aQ7FWNu59Zg09s82EuZkYYPiJ5SN0ez9keRvZjB1A/fJ10Bk4qBMGGQ/FYYeJ3qK3pfaMFYKvcT5BOHACfDPrYYuuM/Ip8IPr+80p9d+frnd9qw21kDDWbszzmgqbsUk3jGAlglQdEEO/WVBmPsaNurNUsd6UGR5SmYF6IjG2Ns8ybdy/qniWIZHfVa+aRKhzaMubUgjs1vdwOqQ7QI2VAVsJ/mKieBeKoPnUpAuUj8JAxvA5NLMxlDmMNYw8bGJtzhXMpAeXlMOTQzqZtwtO4VhdblHm/fQQLXI61IlF4kDTQlYJhTK2GN88tDTbQd+FcYZaqh8F73GHFSvKAAtr5uWWGONgGTeR7ZK/EnBgcaIfrA9ngTRZ++lozD6O2QHwASg2eXf9nl1ddOEfvPW7Ta4u2fB0MDzqnrD0Qof99OJDbc/imGax2UK7EDBEYFQ3yQTcBVxHvcFO6B4eHnqcPvfA5X4ha/sfJuN3P16966IMBNVJlzQ4QGBFOszL6IFqrGQ+7KPB6Lh31BuiLFZQKIk1e/wl4O4wsJ0LtUb4fIP8t79BLqoUItnPEqTDumDrU9F+Pwf3Iz/ZQgNGsjRasL+EVjRqNNuwf2Hh52xzL7zbi6FtLbHXwy5PTzjg3JhkvcbXMNcaOmEAw7mhouL7tbT4XN3D7CXvwU/FOe1w/12yv8puBWHTMRWuIFbCP+9UedW9vi3npv/TuOd77ud77ud77ud77r/wnru1yvlqtnPbXdY7nE/8mrGvXd1rVFOtaLtfroTOKZK15TuT9bo+900vr/BsPi9uxFOajOl+mfR2qkcaPQNenPCr6cYX9OIBS3JrGd8edMqaTqa3irzGNIVEeFMu91/2CpSjgV+NcOM92/8A468c2w==
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 in the secure vault. The wallet then adds the chain as the `x5c` value of the key.

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.


## 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"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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></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}"} 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, the leaf certificate does not use the P-256 curve, a certificate is expired, or a chain signature is not correct.

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

---

# 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: eJztWm1v3DYS/iuEPiXAvtiO08sZRXGOnbbbC2ojdpIDEgPLlbi7TCRSJSWv9wz/95sZUhL1sutcD+19qBEgtiRyOO/zzND3USJsbGReSK2ik+gDT2XCC2FZsRasMFxZHuM3Bm85vOQF42yt00QYxvPc6FuRsKQ0Uq0YV+xidn784WzGYiMSoQrJUyatLbmKxeSz+qyugaoV5hZ2G8ETd8xXsWULqRKk8cvHa6aXbJ7zbQYEPvI0FcVpARwVHPmYj1jM07hMaybX3K5xyxDDI+ApYbHOcm5guSzYRhbrehu+UkMsTNiswPeK2UIbfxD8LNNiwt4B42weHHUOJ30QRi6lSOYVK/B1A1IWGuQV4X5Uw7syJaKcTqk0AvpMpbAnn9WYXQlgHL+BIlINBwKj3TPhLDP0/jW34rtj0NSiLJjSBa5Z6GI9QcLdxT+THk7T1ZxlpS3ItkzcwYJ0y7QS7JanpXCKJIbp2a1dCDa3az4+evndnIijebVZcSUtWcuT5LegD9QxLIpGkc6Foc+zBFwu1mopV+dyJQueOntf5AK+Vb543WYYCBjxWwkO8Von2+jknh4lOFx0UhhgtePS110n5l6zl87F2GmJli5kzMHWLAczwZNjnwQmJ/e+5h1/ZQS4Pdi243QTYA7kKYAAMkYGjYnU9ItFbu4jG69FxvG3YpsL4E8vvoi4gI1wDiimAA/Ar7sCINhpCwy7qCvwsFzOQfkiBcFbIuqvQjWu6CXE7xMyp/veuAbvhWsdUr104WJsEj2Mol1eF4jDjeFbkCaTalaIDLRwCA/8rnloy4k0GE9X2gADWSNCl7/SgvWWoIJ9PLKfJDjpTr8Ht1bw3pZ5rk0BtndRIG0QAMC6dKz2LSRUmUUnnyK/OLp56OtkyCd4kkj8ztPLwDu+yc2DxJGnHP7/5eri10mVWIBz729bzCKPphDKHwOGdAsfd8qd7HELLrUgKqVJmVCxTkC/jsyoys9gvsDClB+g0FySj4P9/+18+Z3LC1AhjJFo1G8Tti/mwyhIKp92x+IevwYLIxkoPDwThTBgtk/3HaVc5M62E/Zeyd/Qn6hoQh0xVRmx4H8LfdfOqpB4wKm9T4NwPh9O2EcsWVtdYvx6wddQrYQZ1XVGxlCJSuXyWZ2JKz1T8rorqtMV8J4M8jBy1pAWImQF3mWdZTakIrcdPg9yjxGFug73Zeig4eZ2HZmwtwKLCGUoEohpsJjXQ4dAC2iQuB5p1NpwwbyplMWbRClcNgOPFIAYINPHsbDWJcFAvQM7FDu9nGHuaau64F997RjUxdLojL76zaQcuVIedNQcQy7WaDZ/zhiXAg5K0W58h4EwB9YJ0deqQSZIgPnl+2s2vT2auno85Qnk4SnPJeye3sPPf4rtLHmYegpjoDBnaD/gjzQ+/9f4qlw4E8wAB0kndiKgoqKeEvImZ91QrkBZ6H1SlSi6JtXn4GGFi04k746+MCukv4HDmVw27o6x68naxgeGBKZqJu6kBdoeyKQaqgWcCtRM310rtAPCpHorkgk7VaxUX5XeqCBosVp0YnjYOFXwUBxURF2taVOgdY47pxSWyOVSGKzvbS7BFzLwNRfF+LTkMnWm/fn6+pIdHxxQhcK845QET2gReG6rNgqT35KnFmpND7X4NA8ZDmpmlqf47rtXr/4uDvlx/HJxtHxxcHBwyF8kfzs8iB5ukKTNtbIO3BwdHOCPTolYC2oWQOxbD/2S4ZqNeiJgnoTA+r/BXm2s1U3iEolvhzmszu3yBE6uTfJodxD0A15IpNBIsB8UyuTxSjsDFRgoKp6jgZqyk/dZ7ZMuV2QeBWGR7ooEIQhRkG741lISHvhODpskhjIo2YmOGUARs2+Qq18iu/3TSt661LFXyPdUMUDOgJKvfjkv6lYSiwagkSTXEqAw8tz0tG/u4jVXK/EtbM966h/ojdnauVxlMy8ZptCuGE0ycLmzBqKQOESWA8JxjLjy1qg9zCJKDzboKKSm1usiSC2/T8gKop359EYdSdU/7ont3RjTDrQKbS5e91BkT3uO/6D1rhKOD9AWKOkNBVr6nqsyTeeNmruUQMnutD2NgUOI//dGb0Dnf0YzMiIE6+tHNewQom65eKZLVbgq6rX0iA08EGarCiwGXcaOFmdI+CpdB0pYaJ0Krno2mKP4e7xgT8+519eQq9v8Gm12LsiZ/zeLeCK1QnyY/t6pwGNREOsyTTy6wYOdHghF+1SKGeC0CISCDnlBoKSX9u9YITMMiyynhtACSZVA5+GFyHSTXYJy4A+pWqS69pR58scfnnLsQ6lKdDnoNJcy6beRBMIG682ODL0njez27tAOoVrccKLjaiHLO/DSDXW8HoGDcvHp2CG9bwZm4THCGG3OwHtwgIK/nwfGuXkMKzW7GzNDKRcrsnONWoHBhwHyQzOcGui+pkyWQ1dSt/fRg+v3+4CxykkeWVH5a9oeGoQXpVG+3UOrldbF0+4h+NAUIxjkAp0MApEGKHVkLnSypUC2rlPqT5Mx7+7IknigwqmY8/rM093DQ6KFE7g3UK4nZtWIrWax1dFAksQaSh01nF4vCmAztjgWy2vX5w7/wj73XnE/FKMQb6vm5V86HOvWyEceHdPREWyCFF8aWWxpYndKkw/49eZhdB+9prEQAi56g1LzFY72In+BwVywsmc1AH4OB8yoKqKSgLu1xmuPXFtSEkdSUTB4SRyhsZukTDHdy2Rqky+bYhqE2zhxdyFOlKHp4rnItJcU07tJsfMvityeTKcJfBvzXE7kCkgWE6kjFK+DL41OSgdbdpB5jMIVaAcRzY7t1n3uMnLTmOAKPdE5UGWIpglwL3bMNFqT4V5hr8dtDXSmMWODbXx5n7fozKsBYjUQyo1Yyjso8W6G5nhkc/YMMp+owJ9MSQc5j8XzEROT1aRD9oT5jd/j+AnVgQO+Hxw2DV3uPnJzyR+1yTiEbwRQsS9bMLOEiLC2Ys9R8jwjlmlPz2sNUvgT6KUNzVQC7Ub4BRPFu+YS7k0VivuurZrI3X0XFFyQDHUku68fgnmUVEtd5ThYSLknAxvgInd984/G12p3kT81r9pOGvp3R9P1JrojlAlierptBtkBCuPPrIbUrcaYOp8AfJ/VWM+yWTUUeOZv059TZR7e2ELtddK5fI4cFTrWUB/BqQEQoMcLhXusr7PO7DQQINQ+olLtppDUv2yZz0XBtACHPeTNBSzjJrFjkleCHtgy1RvrXM1rmrj9+OKMfThjz8BXwf1nb65/ZFfnY7yZ+3DmTptdXbDDVweHL8YvWXau42l2/jacUCzJ3anSQ60SypKrVYEOcQV6PZoc9Ey32WwmnD5PQOSp32unb2dnb369ejPGPehTskhbPkDKSnRc1tYD0phlndmPDo6OJy8mh7gX03jGVcBPdW3da/u6gRqU4ae/u3j6u4s//u8ufBbHC74pTWGoG8aIufc45FN0e+TG6IBE0F9bWMQ3n9SwEh5p53KHSCBxrxHaAK37e7zXfW/Shwd8DeXCEJCCWOKG0peDVVXtJggDEsCH5uZhZ8g8XZ4+XZ4+XZ4+XZ7+iZengwn0KzYl/StUStfwgboit+bM5a7xNZJpVvQ68GbHKZlx79qwp7y8uMJ2YOH/Li6jbjsyfIPzO/j/JPoM/yiNE/SjDh/f30cpV6uSr3C9o4swn/umo2m4vlLD5X/BfF19UtuAy27v5YTB/1G0wS3fYwxDlPxQL3dfdm6ouxW3Gm2B88f/AC+EQ9k=
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

<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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 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: eJztWm2T27YR/isYfqntkah7c2xfM5leTnai1o2vOb98cG4qiIQk+EiAJUjJikb/vbsLkAIp6u7stJ1Oog/2USSw2Pd9ltx1EAsT5TIrpFbBefBKJoXIDSvmgkW5iIUqJE8Mk4puLXmSiILpKf2a6yQWOeMzLpUp6FYu/lUKU69YiFxOJa5RMTwrylxZ2ikvorkwIbsEinBHGqYzkXNkg/Ep8ODIRUIuxPZZjyiVRrjHpkzgYM0mpUziBgcTHa8qNoyATTWN8Bf1i3prt2daGSuIYWNP4DFbzoVqygBUCsbZ8PIfrxmcka9Cey2tSFolK3ufTXWewj0OyxWTP+RcFaHUDUqx6TGjreSOQGlKnsAOsxR5yLoYlCori6EzmM6BS7BLlvBIoKSysDzA6cBmpYdprlNkQ5eFkbEnDvFnCgn6B30alGz0il3BmSCnNcTLz9Gcq5lgsZhKJUl5xJjzAyWAWm3XiS7m7FasTK1gnud85ZjXSjAgbLXDcOPK8zCruB7eV04Aq0riUml/adMXrb7Ak34WPGZj61jxpW9KkETwaG6PP0dliDQrVo69lOe3xilM5iJFK9OpnotHXCldsFSIwvMeq+A5N8gg+ltDObE0Ec9jJE2+KKdspUvni0pUdHKB9gcC70/RNgb1Tm7rh0TI3oEXSHT1mQC+craUoGzkELa5KOnBBagAA6Tp8GiQoBfUv0cxRHqk1VTObLwP5UwWPPlAjL/JBKx4T24S0XrYm/GcpwJTQ3D+cd1KGu+UBFUwSRon33Jxl/nOBFzqPL4rk6D6tuEw9neP4jFQQwmKOqotwR5Dy8gCw8NbFALTEpnLeDGHawXs468GTbjvrA4aKfJS9AID3pPy4HwdFKsMd5gil2oWbHqB+MzTLMF7p9MT/iw6ft5/MTkT/bP4iPefR99M+8fi6eSEv4jPomenweYGqdsANkjw5OgI/zR15zlMpFNQs4h3km9t6yp2/2Rq79uXWEE0sHABJPBMnmWJM+bgk8GD17uS6sknERVobKtDadn2OPEWU+zA2qY0f7en2xDHkGtHeGX+bRJtl4qeFbcrXbik66ksEXwhjA2WrXuULhHuT+EPSnQ/YOUhT0THAja3SaQSo1kybD7prjnojoVITZe+mzq8fGDZpRxF5iZl7Wi6pVfKN7+lXoXsFeVlz3Qeb5UPNu325AlZ7smTjlRPZibVog/vSdwJ2PtCVUo3VUaxdaK2r+PBFppmsUAuSDI69c82UXSdZY1ndeMKhKspRV3JEqFmGIqagZfYB0hWkgt2VgxXzaua0VLWGLOSkz8r80wbMf6f1PAL34q2ikP4xGVEkojUFoxmHpDxblZs++5opwTQOTu+WWnLNBMd2aUOPLDFgidQWLhphGGd5oCDrw1H58vdmqrU7oOzEUIvtsVeXrXD2N7WhiuokVr1K03YpNsf8oL3r0ZDrCO2FN2nyh/LlKs+VnQ+SQTDTZUsnjo90BJW0vgedJ+AvIoaTieE7CfnDJbStBXxIfLvPPV+ESB6QBUQpqtWM2BujQtM0O5Wmt8qgWPsQULspoB7i9sXJWY+y4WoKjdI6dWuOtNYFLo3i9U+7mvIyyI8WfKVYTNpS6CoK6BtkgAtIrAkVYxVmSTjO4vQvqI/+qqw7+D9buTXEfNjn4lxj2HQqeZdA7cd2Qf0fY04jU9e8G+iY4Bvk+fT/hk/jvsvolPRfzZFDHcUPxfHx+goVvId12jrcQsT9zkNw5VmR0EfTi+ZBdsU55fdtt4LdNC5NXUEzaIH9A05+iIq7jdgJwPsLezZ4Xf08u0rdj3s//XDW/b+8j/EZKyjlp73MDrUUWk7tE7ert+w4+dHx6f9pyyFpfsi5+sZpaO6wofHMdVWnlx5gWR7ipZHJFympu7xvIN2E4fw8wa21pA8IP8jBYaNDcu0VNiV2ZCHDStaQekW48ggWMHKRZGD+zBoviBmELlQrVR3aRdb7LraI2M9C5aBZfgnMkO4CyuMyXgEnSqBehuLbKzzWSiNDol4+DQ8Dqc8lcnqnwSPQvYGq8FXoKHu0mHzJSkTtYxmR9Zr5kjkD1VStnilrliQlg14WuKM0PMzWiINCOnebJCJiCHIwwAG6XVAAtXp3K0Ybw8UCRXwsa1Uqq1ce0i1P3a0jSiq9c2QrF0BKotOGqDouiR3dQfZ1HPJYBvivc3G74Y/NktA5fk3m/YyWT9sVtMbXNh+YfXlDWQbd/X+u9D4ju6zzcnDMspDXiMeesNDb3joDQ+94aE3PPSGh97w0BseesNDb3joDQ+94e+5N9zQ4jlAGPqmvMZfZ/YD6YO/W/pHiTzX+aWOBSZyvB56gXXTu6ekbXdvwxeDZyZyvzAAg5sO8h2ZaVtLvuf4zRvDrP6GHjjpd78ENz6Yj4ZYpEt1q/RSUYmj1iyfcSWN+6ZeKsIbBsw60Z9ZCiKE7EeLNbbf/ynuqeVYcJlQKofQrzb5FOnDcdsqx39gq7xTvIREkMtfRbyjmqd/aIcdYXWBogbpJkcgSce0dASbjIjKXBYrGhy5yOTfBF7ebHrr4HsBjplfgILpDkrNZzhhEriJFGZHUtgjGkoZnr2/fAwHWP9GJQF3c43TLIDtSUk47HEeDBYnAzvfMogtob7NwwPQoZLxwMSflsVg4c24DNbN0ZDNYEqjMQEKgOJ1Db4MRaqd9LCuzBO4Ny+KzJwPBjE86/NMhnLm3pkEKHKTwBU11hTKe8jcR+EaNIbwZs92Yx+3GbnZmuUavdM6VWWcLaC1N9wkjbXrdpbmwgVGNSPUZOziakQlHsMH837Et+NjFsY7UDFu0BkzewxLSwQflBKn8jOUNvtOyPLIxuwR5DMLZoockhrpACvmY4AX4SxskT1nbuO3K13mqI4+MPfdmICb74brYEK/XhGwAzmgAu7KFkXCIHy6BSSQcWMq9iwlxzMm5gYTrNYgpQTUoT0sqMMd7RbYN6dTXeUWbmE6JBGJtjVllum8+MvWnrVJ6vdzO47g+1BLmu1LPcgxC0BN2C/jMBIEjGAS/6Z1UXJGs/FIWKGzPzBsZEzJVSQgdilwR48Je3RvbKCxOtivHiNHhY50YtxsGHqVULjHuLr1qytxUNAkHAn4EdtGC3QowFfM5YDG66TSkMcUsAyH9Pokr+T4SiDRSzdz5TRN3DpA9Aj8AVysC1a1MfAgHb7u7BV6AdQIoexrkiqYwHdBryfh0Y7plstlyOlxCCIP3F4zeD26fPnT9cs+7sFmVBZJwwdIWbFriqogdSOGsO7k6OQsPA2pkcX0mXLl8WMHA9miOQYYN4tIXfgOc8P1m8XD3PBhbvj3NTfsSlMhPhcDcBrAAhuXotYOcH0MFid24BQgF6aJBuiyo8eKmkECXjYN+XnlfGcu16EvACpzhHZwxHo94Ua8y5PNBm+TmRE2AjGeUxmxCA06GbgGUDgFI7bfsPg569HPDo4/Zv+vE8ydqq/AmUJkRlAKfsHlLWK39oTz5qZus0k9dhECmKzwtu/0LRsfXV+9uUYQxB1C2qLDW0KH7gLJd/LWBoqWB/wf8Wznlm+xdgFe+65ebp/s3VBDK7saNYVvGf4NA1QPFQ==
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/iuEviwBHNt5KTYYRbHUTguvbRI0afqhMBBaOtlsJFIlKTue4f++O1KyZClemwIDhu1LK5O8491zd88dsw4iyDSE3EIUDGKeGOjgkgm1yKxQMhgEt3NhGMgoU0Jaht+5gYhZxTTwCP8JAZeXMJ0r9cAiSMQCtADDlsLOWcZnQnLSxGKtUmbnwEIlDclMc5FEQs7YNFHhA25x0qOBuV28gEsGjxa05Akb3zKzMhbSbtAJVAbaKR2j0QHqi8XsvTD2PEk+Ons+e3NGW2tQKOOap4DqTDD4sg4E+ZZxO8ctiRv4q3AClXYCDd9yoQkUq3PExIRzSHkwWAd2ldFhYzXaHmxwy64StyLSDD82nXUDwcs8nYJmKia0lI4MOWceRMZipWsQddk5kzDD7wUw3MklQcynCbAFT3JgGJ/EsCkntBS7798TGM6RbznoVeWJimMDdseNIrYtPzCoMAMdUNhjnic2GPQ7QSqkSPMUvzfkT6E2EamwzSt3ff3AH0mQyad81mBzLRlGj7yG7s8aeIxWTUjWZJRLhk6f9Pv0HyaDxQSgT55liQgdsr2vhqxb17RnmrLICi9dBaF2s5p+hZD8tcK6CF9XpzoNBWGuNd6LJ2CP7XWUhv60Q6GACs/AI3cZNDjGrLLK8mSMCW9+QN8tHa5hLkiO8QUXCaVPXffJi1I52fozysloykKiAazrMim2N5ziBX7x+7ovGyaXqbGDRh8Vzrm51rAQKq+bPFUqAS5bascyosijmSImztHwC8LBskJD6wqXe/6WS6Scn79BonRLOzHIBuuoJJgaLQ2aXLHLXFRfoswBJeEqdty1Lz/bwrvKrySgcatEIXEXTL1i3OIFmSfckse77HZOPKwXIgTGkyVfGaJlLGOkIPYriwUkkdkt4C+BIObcZVFfoTeW29wMVQStxRurnQcpGIt4BcSntL79GNVcmGwmlL3efa41XwWEa92GNsadenVPOg30XGAaML1DmTlSr+sVazpw1j9+FrvULQKtlS58d987HjXtaRJLJf1UNW1z7KxPVdJS3+pXNZHgNaaBkFlOGVv0RoKjDcgnyXM7V1r8CdET0Jz9j6H5CEblGotEKovtPJdtgF48szP9twAay2KCIzZBdnfXNDCiIQqwgwq7cvx2nol3QJ8TGj5eA9egzzED3Qp5zWc0xJV8R0CgBXNF0+DMzT1usBsEvcVJz4+HvYIXTG+9JahNL6qzhDfQT4e7PowgVYX9eC7XCa7Nrc3MoIcqUnXEM9EVM82l7Qr1xAR4rVWUh24M3qPmexqQLGc0K+8RN367acikAvaG8sunRQnvNr7cLxSDnY9MNUyeF7VfDj67hp1fj9kDYBvBU5jeRVr7BuKnVuUaJLvf0XPP/DUszQ0+BYB6cywecaRw74Z7byO7ZwdYWOAUWI3jjMMg4yEcdhh0Z92G2gErBF+usCwJjiM07hUOyphj9URaB1P3643SKceiDP74fNv2LQzB0OT6ADi1cmNK87ymwmasA7ZjBNsi6IrajRFOINgWLMXNtS4hY1WyAw8dOyANCIqtybNMaft7Fc9tSMTbamk3Eeo51PBmK4R2q4XATWz4oaKCRoTd4yXFCHoXiqBdZSDHI/dOucM6iYV7jQyRnSjWODWxsTE5l0iAB1fj0dndcHyI77ZojyCOcGZ7xYE/c3Z3fUgWWRWqxFDi4BuTsgokyRh8Cc24LKB1zwiBV0KHzVUSddxlVMLxikViJmhUDWvm5cZljMVjHF8hR85fgTiwOFHL4pVaIO2s/Xw6ZHdDdoD5gCk2vrh9w25GR/gLV/1t45srdvxb//j06AVLRyrspaP3tTtJC6aUG46Q5QEnHYpqWUyYu4jrSbffCt1yuexyt91Fl3uFrOm9Hw8vLm8ujkhmUw17VTgJrEiF+TZ6qJqYzIf9pH9y1j3tHpNspoxNuazZQ89mN9O1X/DNcqi1sH/jHwWKyrK428sSjlS2KRBeF+3gS7A4wYO+IVSTKjk6qE+tNQiQQOeIGcmu1/Tk+aSTzYaW/fPX9QphKFH3/P2kjto/+4eAJwF4IKKv/h7gxHHBd5gfNvy5r/q/MaV8LlaWTOiHdgTxTDwPPhaj0iHbd2nZ4eSqfmdpTBV197AoeJuM8PvUALK6ta3JbVOfPd5eUA/hRYOpmuuDa67FR+0Bt2tVs896E+hfCtaTIi+p9LHdvdoe9zt7BbadyZ8mjCY4f/0FKWf1aw==
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 API keys
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-api-key

---
id: config-list-digital-wallet-open-id-api-key
title: "List API keys"
description: "Lists the API keys of the organisation, with pagination. The service sorts them with the most recently written key first."
sidebar_label: "List API keys"
hide_title: true
hide_table_of_contents: true
api: eJztWm1vGzcS/iuEvlwCyHqxk1ziFkET22mVS23jrLxcUgOidimJ9S65R3Jtq4b/+80Mua9a2W6uPeDQ+IulFTkczsszz5B704uFjYzMnNSqt997J62zzK0Ee3U6YRdibZle0HdtllxJy3Fgn11Jt2IZX0pFDwZsCkOsMJcygv/aeCGpH4fTU20dMyISyiVrdmWkc0LhAmwhjXWDX9QvCmUkoABb6SSGhRWMxLmkhltxx9Y6Z5ER3IlCsrRsaXSeoZo6E4bUsd8x6Vgi+KUAMbkjKVI5YRRPGrvKEu4W2qTN9XliNYtFJhSpQSMtV/FcXzfsUEgx4t+5gE2wj6BUsd7s086Zn3NilpN4xlaCx8J4YcFSRrjcKFvtMghMuVTsiieJcGQGL5l+ClKk25xMJuJGsLnOVcyc9k+6NAeBK7A/2pPnIEA5GZVW5arwfr+hreMXwm43xsLotFCG7Hl0KcwaNIU48B6lqXKpBCp3AevDLiWEyoxn8h9iPYNYEEnchwBiDr0cjGszcKlg3DIOuoD/3aDX75XensQQuJFWC7nE8D2US+l48pGsdwI+nMSvSDzMybjhqYA4sL39Lzet2D/O0zlYFlwAcaoN6quZvZAZgwhpBPsrpsQSPl9iWrBcga4xnyeCXfIkF2wBS1s259EFSpiNZqiuxCUgTAzqoUAL+KoXCyscfMcAkkbARmCuFf2ejSB7eG//pufWGQ7F6F0KA2NjseB54nr7o34vlUqmeQqfb2/7N4XYRKbStZds7vVnfo0Tmerasw8sBvbFXYvB1yo49lo1Vz6hDzwZsPdKgnJMxhh94HlTRH9ndIFeOQQBuoKyvsq5IpCtwKDH33yONIPX5CFVyrjB6MMHEDpOXLtidTRi3KlD3+eTtH3Gl5Ch1gdokaeL7ekGKRUzpV1jXiPJN0F2wN4hgNWTnqDF26EloMSvClk4JVxpDQ+nV3dkPZsLAA/DeBQJa32G/qk4ESaTcQAVtBENjaGoaHRbWGcHh0awW/Qb3+KguaQYIAzyALhFCdrA7PT9lA0vd4cePYY8hoQaAhjB7OGNB6VJfDsMEnZAwoyh/0A/sjhifD73LkCIl37bUDogncBOMUWT9259XzVjYfRJlQvKPDR9BhHmYCfg640ScgWLM7mown2uYRterK1ioGvDaQ5hJ64BIPv+81wkWi1xVZBmNsM1DMLNJHotYoA9BVh3ofSVqiVtH93TzOFu5xTJQ3lQCO3TUk0JNM5r543CYrlYCAMDWlpCLKQQaz6L8duCy8S79qfp9JQ9GY1K6PVGqrC3adoHQZx1Rqpl77bfE9c8zRJ89uz58xdizJ9ET+e7i73RaDTme/Hfx6Pe7TmK9KXLopDd0Qj/NdGwHglIPUTcIF+oPcGTcjiXZ1mC+Qdzh79aFHCzqaWe/yqiZlH50vOxbKkEFnWsBxpmBuHQSa9iMaoSxo3hm9Wj5IYejcH4uSH3ULmg8KaJ6G2RZi7gThvh2IpjNJQ40JbWSVzQn8AobNeOnXTkFF/v32jjy/+m/iVwdQMvbqDJSTYJzNuzk2P2UcwBpC6EqugppWWoLLNXgJnayN9IbskAS1I884qyGQO8WMjrJjLU+V1JlxY5hDmYThC3qmpZATFEholBXQiRNQlUxZ3qoSHjIikw5EEiRgkvGJO4zqRZT9Qhp+hxMoWiC8Ff/jStPSF/QMQSQ49frzcjDBbbyKe2d7byguCzQe/+BNwdYZr6VL9vveMSoqslGo6ItfCoBamGnA7tHJge0T9UV0HJbCp2anScR55oWJtzFVFVQr2Cme9LszMatqHaEY9WjESg/xWy4rIFguDLNFAx2w6lBZAGGKkgZkCYCfpvQmUrtUqTCYU080vg2RgheUwkMyyBhFzNNTdx77wOkLUZxUj8PcTXvb6Zbku4ATujRHPYFjTzbJ+FtPrer/Jy5o3hc6iWyGTefkd3uwFURAwAniHZwOMAS/0K0RBFICDKnmsbNdlGRZpRI9ZvV/MfI3ki307e/zYZH8uJnah/Po0OJs8mF9mnDwdvXwxg0PRfuy+uPn/6WZ4kVsLn/HOaqEkyGgwGvkDV0rabpDfb/oXA1G7FGgJODBL6wFJyhcWp5G6pThGi67QvpD22RAkH7pBnMS8K2kZOUTjujUh8xUoJPKFhQhm8arIoWAf11mJvVDPa3ui2jkwdQYUtPodpPdRoB4dudkR+Q6Vby6qMW7ky2om6ZfpomvfTg9bBh3C2Dg8QOeG0AllOidreMCgiSiCLkIQRaQQSWWtPmnGxO9p9tjN6vjN6MR2P9sdPYdOfK0dP/+DNF/4n6ZgjYbcdKr0ArZoq+fXvzex11o26dAJTFbaiClL7Up6R4OSZXBoOJULPvkMpeEJgxFceGA1qEFeIRZCTGVC58/quy18Rx+sM8t4dTx7Y6K7CwUeZhBW4eAt5RgKP+dw23Iaja8T5IU3mA2rpmGppVdQ7iNcmaEN+A9FZ6RIVGsnDQ5cWUAQUo2EbJ4nIYUJGAcwneslS4TjEMe9kMUCEZYJuc1/HPDY9dNc2vKo+01FBFbiuF07cgJNLirmtpvkBtn8myPZ+X/eqf4TDoFbFBvv3h+ygoQEVuR/C90GkU1yau/8OUmquvQtF2sBGf41m5Q66f1qNans9tBIwQjygDB7U2phwNFbXdYzgph1PJi2WtE3eFAfXztiIXTF+CW7C48K67N2nhXDU9WuEo9J46mgFlZriELCqkrCAf3i/7OOWysVRYMMaWHWhgzs14lLqvK7yXOtEcLWZXyqm4yM6w0AaKv6G7DULEjaWoEbcr3Isrt3Xr6DwfK8t3ZlchDgrn9V64C8eM7Y3GOVRwjamXxH9LhZckeA/hPS1OR8ypBon6s6zDv7QXdb7ZcRUxbFREbabCjGshLAOkPEYsw0Hztsg0MjocTMhx80UGpcBPx61QjUc8ZSB5SONYiGcpsFa+O3JaEyrPvQQpl6ThDHaHOiYog4/H9Zi9by/gWdN6Kpmd+VrGbHQuN12iO9q4UrMfc3xiCLLMSfChUgvZEK7FeehsxJYX9um2fsLm2YazhwBGcMxFiiYQv7TEXdxS1GxeXaCBBaq/x2NZQQ/p1xh9amfADbN/tSfI/6FzV4dneeJv1bB2w5/n4u2g7K1zXxI2gVAiHRrQvjXdOWBxwfw9RzRxvElAXa4RmT+HpE9oqPEwycfDh6DSBSP0A3jQdeVRvBb0k1exlFUb8ulgg0FoPsC8lCkmvmfYVxuEC9XzmV2fziM4bcdEDLwADygBqQtoFaItoi5T8KZQ7Bdbptu/c9tRc4rq55h3PlwedU+4ykPFTsP5BtnONuOnOu3UGW3EJrtxV1nrsVthj9oLch4dQD7SBUdPuSiTMgGGY/E4z4Tg+Vg6xET3p2gOfB26uWMzl7qMXXT85dqbwrC/PbjdHNvtQs3iGBrC/W8pKAzsueGEqy0ICU70SKaUFVr9FsPg16qhS5Qg0eEGkVFtnmWaeN+qPxZukT+WD1qBkI9hlq7KSeB3vpSxnjsCKmKiQ4WlvgfO4PGCxQ+uQg2PwgDHRjdph8AaqGvoTazSUGsHp1QFk4eUxPZPRHqvC2XKDP39DFq5HSkEzoeBXjGqBIK59iAy9601D4jlxN9OjD0HeslrrBmcUCGqKZebiliHAzjJrY7tF8JdmCLRF9Z785gadL2494B+3DAHkE8QIhNjqZv2NnhDnyDp361ydkJGz8fjfd2nrL0UEfD9PBdbU3mezBCOEB/oSzBcpFMELtg193BaMN1V1dXA04/D2DLwzDXDt9NDo6Oz452cM5t1VxV7kRjxTrKS++BaEQy73bgb08Ge4Mxzs20dVDHavrgixklKLcToFbMvr2A9O0FpP+XF5ACxuK7I0NwIxS125BrN4EGfOld7vob3HBnglTA365RHkDdXEFY4sCbG+zc35vk9hYf+7d2iCLA7gCfqmvpranz576/1LnbC2pfy9eYaDo88MTiwYr/3peR7lClOPWoNDnHL4bqAlG8gg/+TuN+e23p22tL315b+vba0v/wtaU7YG7j5aUG8voxr8gptd82jglu6+3rj0dTutX3XUtxzFr0E+EDYmbRzKl1Tfb3oVWhu/mXvUJPSkZYBxrv/wBVLyt8
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 API keys</h1>

<MethodEndpoint method={"get"} path={"/v2/config/admin/apikeys"}></MethodEndpoint>



Lists the API keys of the organisation, with pagination. The service sorts them with the most recently written key first.

The list holds only the keys that you create with this group of operations; it leaves out the internal keys of the platform.

The list also depends on the sandbox organisation of the request. Without the `X-SandboxOrgId` header the service returns the keys of the main wallet only. With the header it returns the keys that are bound to that sandbox organisation. When you authenticate with an API key, the service takes the sandbox organisation from the key.

Every item holds the signed token in its `apiKey` field, so treat the response as a secret.

## 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={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The service listed the API keys.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary 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"}>apiKeys</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

API keys for the current page. The array is empty when the organisation has no API key for the current sandbox 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 API key.","example":"6889e1a4c5b2f30001a3d720"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the API key. The service does not check this value for uniqueness.","example":"Production issuance key"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`config`, `audit`, `service`, `onboard`]"} schema={{"type":"array","description":"Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400.","items":{"type":"string","enum":["config","audit","service","onboard"]},"example":["config","service"]}}></SchemaItem><SchemaItem collapsible={false} name={"apiKey"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The signed JSON Web Token. Send it as `Authorization: ApiKey <apiKey>`. The token holds the scopes, the organisation, the organisation administrator and, when the key is bound to a sandbox organisation, the sandbox organisation.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0..."}}></SchemaItem><SchemaItem collapsible={false} name={"expiryInDays"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Lifetime of the API key in days, counted from the moment the service created or last updated the key. The service uses 30 days when you send `0` or a negative value.","default":30,"example":30}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the service last wrote the API key, in UTC. The service sets this value on create and on every update, including the delete operation.","example":"2026-08-09T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"expiryTimestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment when the API key expires, in UTC.","example":"2026-09-08T10:15:30Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`igrantio`, `aip10`]"} schema={{"type":"string","description":"Type of the API key. The list operation returns only keys of type `igrantio`; these are the keys that you create with this group of operations.","enum":["igrantio","aip10"],"example":"igrantio"}}></SchemaItem><SchemaItem collapsible={false} name={"sandboxOrgId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the sandbox organisation that the API key is bound to. The field is absent when the key belongs to the main wallet of the organisation.","example":"6889e1a4c5b2f30001a3d710"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span><span 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 user who created the API key, and the moment of creation. The service keeps this as log metadata.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identifier of the user who created the API key. The value is an empty string for a key created with an API key.","example":"6889e1a4c5b2f30001a3d6e0"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of the user who created the API key.","example":"admin@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"at"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Moment of creation, in UTC.","example":"2026-08-09T10:15:30Z"}}></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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"apiKeys\": [\n    {\n      \"id\": \"6889e1a4c5b2f30001a3d720\",\n      \"name\": \"Production issuance key\",\n      \"scopes\": [\n        \"config\",\n        \"service\"\n      ],\n      \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n      \"expiryInDays\": 30,\n      \"timestamp\": \"2026-08-09T10:15:30Z\",\n      \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n      \"type\": \"igrantio\",\n      \"sandboxOrgId\": \"6889e1a4c5b2f30001a3d710\",\n      \"createdBy\": {\n        \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n        \"email\": \"admin@example.com\",\n        \"at\": \"2026-08-09T10:15:30Z\"\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><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"apiKeys\": [\n    {\n      \"id\": \"6889e1a4c5b2f30001a3d720\",\n      \"name\": \"Production issuance key\",\n      \"scopes\": [\n        \"config\",\n        \"service\"\n      ],\n      \"apiKey\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...\",\n      \"expiryInDays\": 30,\n      \"timestamp\": \"2026-08-09T10:15:30Z\",\n      \"expiryTimestamp\": \"2026-09-08T10:15:30Z\",\n      \"type\": \"igrantio\",\n      \"createdBy\": {\n        \"id\": \"6889e1a4c5b2f30001a3d6e0\",\n        \"email\": \"admin@example.com\",\n        \"at\": \"2026-08-09T10:15:30Z\"\n      }\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={"403"} value={"403"}><div>

The caller has no permission for this operation. Only an organisation administrator can manage API keys.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (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 could not read the page of API keys.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} 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: eJztWW1v28gR/isLfrJRiZKdBGjdw6E+KwmUOrZR+eICrhGuyZW0MclldpeSdYL/e2dm+S7aVq4oWhTNB0eidud95pkZbr1ImFDLzEqVeifeuTTWMLsULNNiGIm5TEXEQi0ikVrJY2bCpUg4syLJYm4FnuWWbVTOQp6y3AhmFZ6H3xhvXiRaEtn47Brpw/W50gnTwuY6NUyl8YY4E13LVkIbOM3UnAkeLgvOPjtlYcxlwjJulyxTMrVCl2ItOdIRDHjqDQPy7mpDDGTJ7YAZRbwMTwQLUvgbMJ5GLCi4BqQOzzLBNUuUFqgnyJKGwmc3S5E6G5U6wOFUWVCFR46sE0eLTBlpld4MmLSVpkAIzGc3LKjMCNy15huSIVUsyPhCptySJOr+mwit/4/UG3gqE5oeTyPwVqjSuVygzyZyIS2Pb3gcC3uZCfj9rFJ6Upn+uuQHpDKuQW0wnvFObredOLjIk3swK9hei1DpyKBbzYPMyKi1dOiOVCzg80ow+CVP0Qb8PhZsxeNcsDlIZNg9Dx+QQjAOfGAtkcX3XOgNfEHjw1c1nxth4bsW33MJsnsncNeIgeeM6Z1sPbvJ8Ci6fCE0nIWg4nlsvZPxwEtAxyRP4PPT02Bbko1lIm2XZVvXz/wRL7K0T2fnMwZmR62F/3sFPAKp7vCuyVRqwAFw+ng8xv/AixYchR8h4GIZkmVH3wxKt21QzzS630p3u4od/NLW6OyFfEX/YYiGudZwptJKwhEiBQ67nFNIFNq4+Nsx29XLBaJbFiAzazFICg6Rs96zRPDIVaWGHlolLgnze7BZjwh19v3niwaTrmLEkKsuk9vOdNFamdxYLdPFjslnTmBJcs2l0GgnaYpUk85EcxVHoBxSxFhulKNChhctBTzFIwcjoxjnkNnxFSiH9cbxdME54ZZ7T4NC3NfEngAriKCONJEK8wSIDsiGJLkUceQixwosGxg/S7XGPMQQktZnAfnxCtx45bwYoN68z701g/VSgkML+0S1NFQoJ2+/nE3ZkT8G4phzzsgF2U+zyws2awvsJAQfx+CBEqaM0w4unV5NUdroz3CBISo40V8NeYoKkWIFu/VqQeBhV2XvDkxf8N0jaIAIMAubgFq74V8D41a0oAnHGBU79bCqIDyKSFmIqkb4W52LrtTXu4Hisw9kwp4QKMvCgIUq2zg/OKYQ9Ig7YQ8Ymts7n0gB+q5LSN/JeoyDIAr/YKLht7UNEOSCxKivCYgVuNh9hUXP81cZAquvq/ArhkGAkQFWBawGZLW9dm0XExn9jlLScuXN4ubx+29WXyj18U/Hf/v76nF2fbNCKWpxr/fK/YIP1bcfKi3SfFrbBv17pWLB0x0GU8Nu3pyxL2cHn26uD0sbmjzLlLYA0g2mGGdE+bNRn8F9+1Gfzi7Z0R/HR2+G7xg6fZRMzvdjM4v2VmH6/voDm02GoAOosg95K228h/2v8RimrSmrSccHzDmBtb3A0A3s4PxqOjl03jjrFqHX9aI+OUB5IVEC06yrL5TrTkXi8ZpvDIPe0Li8JpTweywCBPbEo6qQw7FGCpQ480puVtnfLn9KL3xplE+x4r/zj3wIFLQdxr7JeLiHZAmIxqrz3UqN5a8NWTRWlLgvNRRqEQtSrSzUtaFfkdarMWVWhV0tMI0nzTaxrchTV5MvLVgU7LIQ2mQirKPMYT16taj1RcSblrC3pWBfx0eAffCv2YTfekVxIYlqYKxwqFE6757uqq6lUOkJJ6FynOmrrW29LmlMgYEGEL4xB1VtddXhUqfn2rNqaIMYh8617AmoeYXue5dYYTMFfzQRqkmQZdrlvpic+seP/qGuM75TkAm9wp4YZrxMtPNrDDZyc9TrPHaHqZpXNUSxiRuLaMI6GreYHSE3q2CYnXZC7TmW13i4lyFfcRnjMNrmcAwcoOmHAWYlVW72qdBphCELJKE2kFc4LkjouvOheMTNSYsPTYeO1YV43AsIetikcPVZFlT5KB/aUUuPnp0J66azYSsMM4hCk4ehMGaexzGm+xImL9oQbJHiW8i/HxlYm0kqtFb6TEXUBuDnSUO8u64C3Rivb/fFQ2WPt2OMnh3yPXW3roS/cOzgshytXGxE0H67Fvw15bldKi1/I0Bum+bdD87y/1ummSKCpzhQuipCbDo2wsFAhLmWdkPbhdNM/lXgxztc1/wC85TQp2BgeoJa8wVuprxitcXcbosdVAh4CAymxuQ4EFGNXypcii1oi4SIB19Gq+OR25KNIkdnuCY6IzBhKqORiaDVHtVAP6yTY2Qb2zKnWN+qbCISVegN53Idw7OltZk5GY0i+G3IM+nLhYYhzJfKQ2W7ixQV5SGl4zNkXqMws4gdi+euG/dzV5C72iHUpbtwKt1SI797UKzQnEfrtd1pkRIOPrtxgbPwg9gwTBy0b8jr7Y5bWhRQF7ToBMyxYUkO2HdPy+i5fITytJbQMQZORhawA8BSB6RWQ6knG2DndDhgwl/4HbInrLj400blGs0xBOF+hj4OYrMZgFvvnr59oKYP9IC2fFc3KpSAYA/QLWbcmFI8R6mQGZcuLSFYZUEqBgQHdMGrEh395mG+yHSuyqrCQ6oqUD4k+rZolP5S+7NyifxYP2oHQjOGOtpUl0ButYKemLp0hYUALCzxf+wrW/2Jy0RqfaDdg66O9r410MBYA+nJcf11UPR/hzQw918EPDYViyrNrw5RIqtCFZuin8KoEinegd5KL3hamJbaCYkVYcCWKo7cdL5CDhtWpH+jpzfQhVHEWDjGdWSGpK8EO7B5rNbGubOwNEnrJk1Go+agM7Q5bq1pcVJMiztzBKE4oINIjajXf5B70LILduyPd1y3Xq99Tj/7oPKouGtG59Oz9xez98Njt3oppsKGO9FY5WhVJmm1O/KOx8dv/Teu+8+UsQlPG/Lgm4X+bRVr1saojScVBv7/bdJ/+dukot5YaDFHcFPSnoniblsAKIxex7iBJAhFV7dA1L2QAhjFaoZA6jUXRA0oRV5VwADuLCHUkPh2i7PPrzp+esLH7v0MQaw0mN/1O5ZnY+zf+6aq10IPiI/1Cyu6Dg8cMO8t+I++dnpBlPIlVy3JHX7RVFddh1UCNxrXXUL8ypq3dhrWp2Zb9fE9QiAv8LHuDR6oNyg+NN4a8XTToN1tE5wI+BeN1nvlJ6xcgNY/V8fdL89eqIDVnUYD4bLgn27L1uM=
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: eJztPQ1v3Dayf4XYd0BtPHu9dpy0MQ6H59hJ6zatjdhp3kPOsLgSd5e1VtKJktd7gf/7mxmSEqnVftmuE1xdFO1aIofD4XC+SX3pREKFucwKmSadg857qQrFeByzMBeRSArJYxaJgUwktlAsTJOBHJbwkg3SnJ2eHO//fnTitpZKlTwJxRabyGLEipFgiZgIVbBwxJOhYAOZq6LL3vJwxKBPPoXxVMpGaRwpam4hwGBlAuikA3rcitEW40lEr3OhMsBQOID4cJiLIS/mgkzzIU+k4gipywIleB6OAjbmRTgSGkbM+yKuBmnFgZ0cY+c0L07zSOQBw58wRmIAwNTHaSQHMqSBWCHHAjrchEWwxYIoDYtpJgIaI9A/CQHqfcPjEiZS0B9FmrFY3AA+gD+HGYdpHlE/mTAJQzro2YWiIVX3n0lnq5NmQv99EsFa6xa44sdyKAsef4J1F8VpJuD9UQXpuJonQMh4zseiELnqHHz+0mCe38pxX+SIm8YMCJgydS0zYpWMD2ViKH0ILAHrIm9wCViZ5IJHvB/b6Q4AEcX6PLxGCEEv6MLQEof4VynyKfyRABbwZzoYKFHA37n4VykB5c4B9FViq6NgAce8c/ClgxSFpjIpxFDk0BYWjpdx0TnobXXGMLVxOYbfd3dbXyzYWI5l0RzSn+uv/BY7sqRtzrkoyjxhQG2ctejeF8FdjZU/8jsZA/1Zf8pO3l68Y+fH2z9/umC/H7EbkQOPERkdPkDoTNJfAynyeZQEZuy0IKWKXCbDzmI0zk/Z7g+93RfbL9n4OA13xsfvGXB1OYZBVx3f7IL74vDpxRH7vZ7/UWP+G0giYELYV5vzMFh/+HMSFwxQGOOqDzQ2IIdg8YB9p3MG0lJmJZ5YMDaIGNg7IG5oc2kBiFwHgtly4gZXoUgigIC7DPvrv+aSoBJh6yC31REJ7qDPhCH8CaN2Lh0u1s9b5vBpJBKQeHkpQA7iDJTIgYmBd0D2JikoDB6HZYzyu0UtdNlHhS8kSFqCSITgIDyUWQZSB112UUMucERNJ8X+LfIUBWdQpCD8jhDo6aDmnJ9AMKb5NLDyVaC+CiwSb0BkXUfpJAlg3UUczSUpiD8CrVaiaT9NY8ETVwhQ0xbqndIPHgMdEgmjOpvMqjcFqPfTW0/NIaeWQDjNNUA8REqgQqblmKYlEIu0HbwbgVwWeb04Eqifl4nWjJU2QeqQckxBhN0WdnSkQNSKAwIElSYVaO8hl4nS6m1C+kd3h9et2ONiIGu4/cbw0+vcVOzvBb/RPKQnxNKysHRoAABF+c/kwp0u9FAuNUCvx1M2scTiJTJVgbpdaIuHsz7scGjIw1AoVAjXInHI29IjYYdnJ+xaTH1SF/zaWCGttBjk6Zjems6aU4dJmgsPY9gCKS6bGWcbm4Zo48Gs+ZwF6ktj8WBjINVcJGgCwdnHC7Zzs7ejbYodHoFi3eGZhN47X+D/v4jpSXS3YyBsA4SA4foBfkTx4H+3z8u+XoKTCN7paUciA2EGdIqIm/TquvNyiIXcJ5NSkAZG0mfAYQXMBNYaweuhT/Mhwp/A4EwOanbvpzANDVbVPNA24XEJbCduQTps6d9gH6YgYmFUgJbPsqtphJOJ06mIwPxJwOa5TkB6OJsWLdnGHm5fHLt5aB9YoNoO9iFQO42dJgoDI3QgclTLPpbAC2PgNb2L8a8Bl7Fe2p8uLs7Yfq9XCThNpFrC+aRdS62B6rjl4yzGZ69++OG12OX74cv+3uBFr9fb5S+i73d7nbtLBKmFuUIge70e/o+kTVLgT55lsTGud/5QKB2/OINmOUqqQureYZthe9AUrkft3o9VtWGZExXRutsicx84FMyQRfb+RWXNw9IFSRnHAaplWDIxzgrYvHnOjVxBMAjauDJJalQ6rUEhxjQRWKbTAVnhhqpp/w9BVtwKU6l8B8VQy9XYo36zO6t2N0jFKULHCKgC9tqw8qMm8EYYmJoTgzY6q8DMKE2Ecf2QoqRZ57kumotr1FhW9mOp0D0zasf6oM5ET3TTX0UBfkXBtffj84GM2kwZn3QnMxq11f9DasGaEpEc71OhxDL+m2onCIgiXNN6F7we7IZ7/MX+9sv+q2h7X3w/2P6Bv+5t7/b3whfRvng5eNXDfdMObPmMZk0FrhSoDGAAI+TbPdwSth++Mgq1srxOjrW/Q1IlFAsgwGKRZ3lMS95qqytaNzLxNsyibtZWhrofpVJyZ08dcbcKnWZX3iBvzAwtdrWDg/xpV12qOSxiFg1V2WHhjK/9x7Z1uiW5oQqYMNsA6inYXUmkNoGSEUkW0DlGWswbFbBVzIzqUW/3+5c9/Q+gVWbRV0DLEZPtyL0i5Cj8sny9firHPNmuwgg6aKOb9BEjkh+oLyLgdDT7rCXRjuCG6A677DsSI+wMxDtBPbY+7eHud5s+N85vOW+3KmdSJPoXCW4/mLMYeS27Z4SlcMJtCi0LgbGcQswXvKuL11bdpr0xo2ecTQLazBvHU2qLVdlpshBdBWINhpwXJ1yk6p6UXPfSRXOcPDk/6OfNbCgSlKPGnaC10mJcFhZzR0Opz5ddGRnX1kpAguSOZjzHLeshN4A4vN4Ex1GjRA1yetaJ9kn9zXPkzu5+Unzu6sEi28WP1uV8oxNArBgVoLcCKUaax+J1YlGZVzLKKsBBnE5o+k8oABvbkszzTBpyJ8d8qpZriDoGHEF7cHMKcCQq7onc4Qi4UDSQKrMMhOcHcZNqo3lOTGRh+MiwuoGFkQ0LDfFxuNt6zlK1zLnuBas8SldgM90OqaqTIt4WscAwQ1DwolRXwGRFYLlF6CjuBcYI2Dk1YBiSZyoTYeVC+J2v9np7uw4EDH66XfH1bP8JkOeKYhFXLqwbF9I5NmIgnAYyJhaZwavrxPscMBg4bSCIj+aO2bm8sz0Q6lE+zYp0mPNsJMNfxPQdhWqXU163q8JdYMgir1+L6QELIhkdwC9ysoLbl73XgYu7eQtP8NUSdGo5shwlaO4K6Y3gGiTfZguKXfZ/aQnedkKRTp0aczI+AwxiYnhC228LvA/aqAkwXihqSaXVRSKUWncnNb2xMolE3rJZUNWXWilhogOVO4b3681cI/NBWLm2LjIaqkIyVcI0r6AhVbUUiXCVE8Hzbfp76u72hhZ5IykIrjftKlaYwwsUDetrAGysITyKgwp6M1XiivhVKxAZ6UCjDTkEY5VejaM0DEwio81umg3JV2z+x+Qa/mtHAYYHomAkMs3lv2k9P2jyXhCkpeomnbghW7M0inkQXcVmaeArOBZ4Ha4ioIeMlZFIH94dsdcvXr9iHySw5KEH2mCrULKFYEtd9TmIX9PxFNuyvW6P0Tu9pZS7/VuHpexPBUvLBPx7OTlaB1zPQFOiMNaDtpLIhwrmrRBxiTdz4vJIqiwGJl5qSR/rhqy2Q+vYloMtz8kYMqv88UTN2q46CriMQHY8iuK2jNQYBO0e0JvxCpDfHJ3tfw/2TjIsMWJW8GEFP5qZpEdxHk/QRCHCByLZ/vFNsOWF0HkyZRoNvcdtsNh3/agnEd/Fa017zXnZYqpmZZ7BxiW6YFZ8mKcglY/SOF1BIf0kboHtYrRL0qiV+LTMNVzj/Qb/9Y7+CTZpXMzsPGBEygslrSPb4XRAwgwXp8N0ORu/h1ZMjnHhWwx8riOmPr+CSFrB2frw3gKMqyEILx4XFzCX5SAOMRmc6BoHmr0lvAfwzlvRE3y6fNZv6qX6c+febwxECN952vSDicyfgG+Rg9hb7iH8qksuWJbGMWoHaXr60SRLLSMVSBqWqqlNjjHwiNrfUa1vkyhLAWhD7a9qUjqQBo51OeMqsOCPCViy4RUmHEgcUw3CEdUabMLrKPxvFW1DI3rp12p0XXWOb1tKKFx15QyFCFvI8NuCIW1FZgOhd8aL0fK5/nx++hu2RCMKBJ6qwu1KxMB4yiQi8qJNJvFpnPJoxvoxOKD4dFK0YczlWDUDRX/r3mhzxiemySD8zbxyCEnPK8ppueTbK9aIm2MZNcV0p1kpotupFVRzk7W0SnbnQUCUNT8YzzIwUKtAia70mo2wRD4jIcpYnLN0MdvLXy4a5Tf3nZezCEZel3lyIMquKEHE8K4I4VckDzIwOHeNDLc1Pcutg3nFQvfFtt5cBtk0H3alSru0ybovu7vdOEO/rDsvPPtxTVEJEh7FfWw4nen048zuoBhBkbJ+KU0qzbRvFzIau2/AN24i8e17xMYJPSwKTFaQTMzTdPCAuJKuKUCzEOzyGmyA9iVMZoMqMOrnmy4aP0+KRxuehIwdFf4F01AZ4b2hs1SkG3fBGwmo0RWOqK4MKsKyPeDrUEd9qNL2S8Pw9NhEmKZm8dypM1MCgHta6TJIQlZLWIuGjcPPuMWzhosDezl6vyxCxtoV3zktvnPQmx0b5naFiQPfNGsPFhzSGsHUkCCmE9o0YHgVU51LV1okbaHO3zl5e4R6f/8lmFpKhpsr+fQgx66o0xV1wi7VE5GM0LuOtmdfjcEWxwyA93AkhyMs1qvdmSZ0NPdAauVXTtmSvwxLSIGdmd+5SZJvcto4cbSxHonfANTT8tk3SdS/LC+R10SqfjlDHTkmgaviKIdJQMD6Bqud3BysV3sEow4NAcewbjLnDOrtC0UJ2hkEnSIfejc3YLowFewjlPkOzpzY7SwqM+6NRknOhCaMf2PPqcS0n5Fq3PgIOsGdMI2gLt7E+jtdxm/f6qoumUTidouIXCfHgV3zaQVZZ0WpeZe985ZDmwF0bMZFhCpXwXSmoJrKeCg8+rXqbI3lfXDyqvU+d3gUocdIIeUS0+RkJo7BQeNYNf0QO0eH5WQSxmUknEXScSE8mnEsVRinqszXzidQDTDlFCilEGlAwuEEzRsSRAnOGSM+UURWJY/PHA5EeM1YiF9Q+I3scd8hJWYmwKCtMEeqy3frrucl4fsXFAFYKDsxMQlN7ZkdN4dOT7TlZgbHoWs/7Cn239LtQDsCJqRWCoL/rhs2Suzm1ge2lQd6ae42d7s2wZqpJ4PmVW+XdorvOuEZNbd2qfY7o6pmX/A8Ro/2xp0GQMJyfJQuVC7LwZkd6bhYKdp2sXPGzxZYUomdPuqA3GF8YViTwk891DN4DhQ8NHX+6ePhAzaNsfmVq2CKlGFUFXc1NxndTybHBcMzx/dmGzD65vJ0qRNQoHg7J0VlEqO6uNVGvx8wlzp/bcwZM45N7ppDA8KMVJ8kWhCMmSqQkb/yBPyU6D6oZTEvMBzPxgRjYaltC3PQ8TegPJYHalwMoGgRY9wWIlFEUxREa+ONEsKCoKhHLK04dcbkBV+Fgg/J7LYbGfcqd9MMrOzJqTq4Dcwe5XyyWh7qcXLGakQHaNzMsa7y1CphrYl5YvW9GEKTMxCueLbbCCSjYY6h9XN6+htLT7vzNY+fOmXtoaAf3yuNrZm6fdh268E7yUXJ5epsYpTSGTGSPVMQfR8/nLSxmD0QS9AIQ5OBA31EppE+oFQdTWqv2a2quxGHbzvv3hBj6EvblvrMpuzLWBbGAazPs32mWdTIXP6Z2fvlix2maBxqIF95zWcrBf6M2oPZtbhsPiTVUolnH/6sdHJlhNmssyt6+WSF0I4QedH7qlXRc+2Qb6M6emvteuit+1RAP2ax859YoWs4yinUdc/dPVfpftUq3dazUZVYNSGGWo56WD9Cie9jFEB5p0U1b2nj2pCsy86rnK7uog4a5VEbpqYFS1q2/GoSvzIK3zrVG22FUZvPlVFfsTKqwQLuzmkcOXmE4ifXcEnHsiXq7WwikuE23BY2ufiRC6m0PlstudZlJzqYWp+Sw7u/TNzZn36jTtDzKxZUXD1KudXyOdUMVvnFsyENM8fWa6GMRFlaleV5sM0pd6FRl6ZcZb6WT/o329SdMO6iVjxdxeRvTW0Xm+xeo9xmzsnTvgh5ddWMl7CzaTw/04D6sk6VYO7imytTs/dRPGe1v+WU1nNW+zmr/ZzVfs5qP2e1H5jV9mNMEm+5mnMDz5wLZ9zLX9wbV+z5/jrB0xJravHi5lsDM75OnY8HlyAvVXGYhCOKd13TRJz8Z1vEqSXksziYsTiysHoC07XumhnEluTcJd6QuHhrLbzn0eEt9ybW9pCeF7wzOUZ766atElgaTXO2wf7eHZYUNq6WXC5vq4IIc63xkkSiexVm8xZMvWEdyavTSQUL6issA7qOt0pvRvriZmotiyrl6l3aae7qbF+LFWh+ge2cW3YXUX5ZGrVJcG7KStda+uqaXyvrjeK1wMxV0fCS54JC8bh/rht3HFF4V+KRhGHuRwDXxAAHUYXUlzlmBpw31Pcmant9z4lORmhKeOHG9ilRBCGR9xwGF28ykubaayO1NTyvescbc4+k82UV7DDq8g4vqra3TbftokIW5Fqe1a1mDAN9xd+Zn9OZN58j50JAVmUE6iutEEPk5JOGEbAq25MyZvyGyxjFnUeDlxY44nof4BlVVNAxcsw82tuvvZXVD9dZWI2yvQPbowYy/4irM2AjmZarxL9P9OVigi7txACP+A59lsxAmBlCX5pLo/zmpw3XHCHBxGATurELapFtdAgmHVbwhA/nXktfnXql+xT9S2y17YbZTVVdR19zuc371dVQ6kmFr3+D217v64rXH/afTLzu7T6RfH39FeTrK238+uxMj+bGit3rUjH/hVdAl5RUH4BzgPatuWUXZoGA9te8zdU1xEWep/lRGtHmxN/HDlaXTbybu6Du3UbP2lSgewhnwLdlZKqQ5RuOod6sRNFhPphgj843dlgzp0/pOn01sH8CvnHfb7eFkLt/YUJ+TOxVKeQe+KR5+ZfmMfK0MOZrLH8apkEjzAebc1R0pfAhXdkNP8mtekP3maObRk9w1nyIXwDpmC+H2MLW+vzpJgyg06dIpLGpFegM6WsdOsbRcS4MjzScbc3sO+hDy2hHRX9Mip1aNG47wgV9QppP25dIjsU4NdNFdzsHZdcZFUWmDnZ2Ini3zTPZlcOcJ0VXpp3Zy/VBc0RlSDtyDphlEMAWGGI8dU53pV83Ebms1+Ec2VFzkV2NOiqkH8y5kdu7KWnW+rCXxXvH6NwshwnfBR6cwF5/b68zB9trIG9tOXygcWQB2wAxpX2/IgdzlWiATvzmFtNZHw/sATMd/46XpyM58Hr6f+gMpst3Xzr6Vn2bxu78/Olidm7OjfuwLZSy6GlIBmfU5f5tUhUFSQaQmUgdOtX+xnWjSJFMBqkVJlynE0FqSFxbE9n4n3o9qyWRP9aPfEZweagxm6oTWh43EsNWHGw63P9oO+L/MbpW1fKscoai9Y5ltKnaO57pAnZTpW5399kmYlSkYarTY+bMg6BQjDIK7d/mstoi1daGLhPRcQP6VM2UmV3vFSHpS15geyQRB7tlm+YrOdaZx+nEhHYNpQlbN2G81cif6tGWZPhszQKqVFAKIlGiLlKGvceBJ/Bur5mlm0wmXU6vuzDlHdNX7bw/OXr72/nbbexzVzub9XIisewHcuwmrQ7NdPZ6e/vdFzrBmaWqGPPEwYcqmloDHM3d4Ci85+96/Ud/18vIKKxl3MliDkrhzvCqzSd87tzsUVYLO1O02dW3JmpN4WDSuV582dO6oKDAXykQ4pcvGDL4mMd3d/hYf/iGdDFQXh+YMB+AmMuWf+4Xw1rJgpVRzofDqDs80Bp8ZcTX/fzXAlRsuOWemDz8c2ALcNNfBXs4Zut+IWwBSvWHwh6M1pofDVuA1MMwWuE7YgvGrj4ndt/RH/olsUW4OR8Uuyd6/2kfCVtELfdbYTW5LvGPnHhUO2TW4F9P1j5/L+z5e2HP3wt7/l7YE34vbIGsm/lqmKcedBt97Y/zbiZqd+fGln58iwEBXvr1M8RT+Fz/cL6XxZOpA7sZNNEo4H+dwgK/y99xHwGn/qNqrt/M7VCFGXRrpMfl3d3d/wMiaPXX
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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."},"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          \"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: eJztPWlz2ziWf4WlL2PXSr5ydOKanV2P7e52dxK7YifZqnQqgkhIRkyRHIKyrU35v+87ABLgIclS0jNbk66uWBJxvAsP7wL4tRdJHeYqK1Sa9A57r5QudBDmMpJJoUQcyPvwWiQTGeQyTPNIB3equA4yMVGJwD6BSKIgpe7QWheimOlgrOJC5iqZ7ASnIrw2feFPlksNA+tABBoexzI4Pzt5+v74zJ1SaT0TSSiDWI1lOA9juRNcXUv6XeaBTnMYoLiuQBrNg+Esi0Qho6NiSBDFUtxKHaSzwmtZXIsimKezIJKxhOY8MACVpYmWgYh1GlynMbQUk0kuJzBkBU6YzhD0cZrTmHfQUAZpPhGJ0kQLHi0TuZjC4LkOhkyPYT8YijCUGcyIn1VykacwvNYM7BAwV/AI5o8N7QKgLE6iYaiKqjIGiN8BoGkSz+Ef+DDGZtNAASMAj3/MpC4OAzUmJIHUUTBNc4l4J9i+T4MaQt5ImWkeCn+NhS5oTMVTA8Gg0XIU+iX8O71+L81kTsQ4i0CcwjQZqwkK1YmaqELEHwBFWZxnEp4flyz/FRqk+Ry6V8TrHX78WhPON7PpCEkzrviZBvpGZcSTSiZ3gqMgQeapW0QjmCW5FJEYAbtuRTyTwRigALER4Q2OMNwjyBVOAQQkOBKAAr6m47GWBXxH0iqAt3cIfbXs93QIZBe9w6+9Yp5hU5UUciJzaBvJsZjFRe9wr9+bqkRNZ1P4/PDQ/2qHjdVUFfUpfVxfi3vsGCRtOOeymOVJAKRGrOXOugDuM1T+zD+zAC7SASOSGJWXq7e5ZI3QAitIajRJFlMfOCJgMU2nYqAlMhxkCjqi9I25ie7iBw8K33Uxj/EHYPwUvsr7LE4j2Y28yHOB46hCTrXzuy5QTeEICXLpI3Jc5p9RSaEw0xfAWoIkRfBDkd7I5DOtH/xa0aj1N5Cv5k+8hvxfjTZC+AwhP/OS6n166OYQcMFhEjAVZI1UsqLfQF3kRlhyJW9lk1mWnWPiiM5kCJ1Cd1CkUhcvqmYn5dRniEOD+IbICzFBjYOaV+Z/0cEJUDwpchGr/wXROKvQ2To5O9nuAoi7n6i1YVBJpG5VNMM9qJ2ElmJC6zRUJLi0HzrUqwbpgrNqQeRavnJXgX0qMlQHS+COVQIiiY9aIaZRcNvugJwn2RjqSylysAoA8imCYnY82ExAKaFy6Vr81G3TucF6MFub3chZm8qopNKW0CB/EYyAugr787dOyUOT5BzHfAxwlc7BGeArzNr75Ghn/n0h18HmEWCq5FJOge9d3Ld7vrfoyRRypKA21CS9lXmi2aTRMr8lDiGhQPqTQOY5kObuWiZBktb7TkUBOLONRvq8i27Y78h221isPiA0wyKfSbBJLKyleePhXWmbwGpkssSYKGAwJWkBPW5B3RsbkbeuIUE1DK6FRrwl7A9h0YWdo+uXozVKwZoUyYZ4Iei6UGBGghGXGQvN4yHs5fEMxi/x7ltbGD/gnkOEMLjb0demQWUn/jlUAKMczGPPmdiYj6b/n4PAmJaVQvVYWeqGMe46XhsbY1hsiMy58fjAHUkUzOCqHvZJwHVJolF673lIqJZmwCBWvcQbcll2AqJO6bTQs2sw2mXOLgtKr0LtNUtYr5R+hnVXwNUo5H1hZ0dso1YY+rxUlO6DyhIq0awO7sgz4e7wuBV6XBmoGdx+U/joda77hK/QFWWNQwixU8p0qA2w80fyR3Llogs9tEsNFpg7SywxgxGA7iE6qsYSGcE2afSaRm8BLFaHvC09kuDo4gy8wblP6kLcGB3eSotxnk7pqelMxFGTBNxND2IQ1BTZZuYZYNNQsIYSHQwaqYSlHRsDqTqBIASGF++ugt3bg132NndFBF7XrsgU9N79Cn9/l/Oz6GHXjDCAEYYB8g/gI4oP/2dwORsxC87ADVeMdoThipCMPJQm5q6Ll0MslD6VzCS5Z6xaA1UAJsBrHJ6nPs8nOP4dTO756KMU0OBhdSUDbQhPZyB28h6cpT5/Hsk4BTsFZoXR8qa4mkaITJzOUQseJeAQ3yTpneso9JE9/hpuZ45dPLQO7KB9msofgdoxdEyUIFLoTqGB4EMZo915w4uBJGMsVMys/fXq6iJ4urdXKjMmUqXNfNI+yoBAr1FMM3Ijn7948VLui6fhs9HB+Mne3t6+eBL9tL/Xe/iEQ3J4iPzGg709/EPaBnxE+Ag2cYzLCXDZ/aJRO351JoVNGDRVobh32Ah5HNY16/ECv9tarOEsJzqi89+ngBjI6MgJ40zTCI06wzE1NdsFecHIPDnNinlpvpnwnDHbdlrc5HT0BbaURpCiG1ZjZuXgArPrX3c+vZCeiO/EXJebItis+ZzDXTguriXYN0WiRYgTn4DVOMQYD7egmczWx/uh0pVNT2KkCosyNTgMhn/0/ugNreNLAtHHOJD5hYMu/XJj5V/Ndsghu2QWx+ZBEjB5Av5CREYi+qwHt7TFBfDpedbYRLujMEhAZYKCJmZZBgyZDECSYcWhU9P9jON0lew/EfvjvfD5weDF+KUYPBX7Pw1eiqdicDDeG++HL6PnYn8fV0vbUMtRapoHpRB3otZnwUH/CxuOgdROYIlV09Lo8XpIhmsheQxEjwehoBCyAroDjB2kd21xLdHdRd1PXNTVVmd5yNHeomI0bJqJvAsolsf2j14PUVcFr4JiUzTbdgU9MyZDRccdmo0Cvucbz0mB4xNrbvH2Qy4nzQ8LDm0ea39YqSII6q7mGpPXvFya0rjJPKGv2wzDPGXreeIzhFR0xfDYPmFp92eu8CkAdLAw5HsKmraEO32UyvYmyhroGe5doCVZwdUQHIE8R11IGQX4OKwWbi2+uuT9fRmT3pR2mWWPRbGP6o9mlpF1EVrISIRYPs97Dly3TVT5MhxQoGEpwC+jE6XDONWzXLZ4VfU5PP/Qcf6mxg6HGapJNfjsIeY3wBuIeBbMb+ygr+bYQB+ZjhbPT/hU6SNyDWS0AlBnSUSuAnrWEoDK3dAJrmrjljrspqA5UUHpK/Q+vtV0aBua6azep/GD0yTKUlCJFSu8pW9F8zVlCJaueyvIYEORNEctwwbDs+QKzKphMAU06ioP9BMrAxS9KfihGCkGRt0q4UHvmE8WBRj5RAL9ckwHto4NYGQmOGnHsz1aB3TijPCRwYYPtg/IBFLoIpdH4BmmuVqNUa3Cate/zyMYemDGxmj+MZL15zi9M06psbF4FNuON5WyKREUB97x9+hzFLXlLL1qpzn1Dt69PUMnrLCbrxE2zCwWIi985MYIt7ff4hpQ0aCCaUDyf7i7+19OgocTSbNc/ed1UWQanoJbuqNgCwcOqXR3Z6cNM8vDFQyQ2vILpF0SRmcZrEyYwUunQ1MWsgZpiCIgb+/evqI1wD0GpMzJLa5sLQ/4S87SLYh4o7pnISaXTURzjny7OF3wbo6CbhLgDZsYVosZpnuxjCSOAJ58JnJ0f4c0nW2vyJcVt+BxUn7YGqeVFNgoOuGoV8HsXy2FWCfsq1qOdpGvYXZOu3pgjy7SMI1pIYAbVaE6DLYa8mOXFRNzu2/bW2pAH0NnHYoEt5IUkwz8kG1MbI8dXapBNyO7OSBNRgq6XU68C3s0CAvdam4CdEQV2qI1awMQFypo4WuS3sFeNOEIuQTSNnqYWgmnk8kzVK1qfQwLqy7mh1qPGn8rapgosX2+XW5+MscV+Vgzx/J8yEN8RmGBDa+s0PC0CFl9irhdBu98Zf6WI72lUvG2aGH2HmpqWq4IMzWzlQUGcpw5ONjZ6wLBpoCMH6GtNagiMig2BgBcFLZMGjNWSre24bTMv4Kt8vh50CxG93nCCU/uxjZ4kxO4Aa9BhToUNq5TpBM26igogw282YIQpmsHYvn8Fc+bY9rFbpV7h5VBU2euIbTa1GjgiLJP64xLbSHCmjQELl1i6vKJj8oOrPYauU1alcD+LI1jD47FFiNu5gDZ8TUuD1iiK5Dg9+NTRjy0nVpXmd1PWtdl3WV7+/Nx8NPzJ8+bAL0GMUpX8OHbwJpS3z6xxphxwfDy4NnzIc0D9ADXKSze5Wr5+G9NYzIi6/jmcqLAh89XFLwQHPHVIhPH1LIl41bWzzAEfSzfUeg1zWHJn4CySNHcfbUDYpjeQvcoiGa5jbL5LpVhCYcaVglddpbsGNiMKuDcGmif1jARyGt+oVaQ/KsqGsz83SruP+OH7ZLWC5cazMvVoh31cbUI5j3F0GEDnGaw2yYgymEKVvO2DX8425mNf6PHYmbxHIb9n57t8X+Iry1a/a5gOBkBmwXnarsyhcoltWniRBrbgH5OQFv74sTfFzaAW7ZW/15jsVHS5n47EfDNUPkeYZpGnLAM2uiuqI3VimbTqC2K6mtb1ExEkeJU/IUTP0Pw2rxgh86ZmMepiIx/xFPvwDJJCsxtA4YwkSlPdjy7Gc3LiY8PT46D98fB1m8frmjZTQWoHPh9eAstdodRGrpjxEJNNXc8O736Obg8GUBHHGA3OLs8D/Zf7O0/GTwLpidpuDs9eWVG1EYFWQ695gq1zUhxafkQVAPb2rc2CCsCaFPRjrqOiu4o1om4AUHRqEkp2eQMq2VRUEmdx8pXYiTj5XqOmrX4Z06gGCvUWgLTXkCaDIEaBF7R5maZKQeax8690jaL8QeMgyegAWBDxYMGj5/dHD0gLbEJ7iJwR3Jnt2FXkqBonoipX0xrrO0mOI9JNTUZ4YFTqkiNoRP4wa347IaJQGLzoZmRBmtLsIiN7HkKZwQbCx6h3mg3Kaqw6VXTKSgroIYYqh7aUw5XVIBBlZDGqxjJMR9lKM1bCtCxzsV4BKUl3nFpA+U4v0WGoUlvnrzVuIJln8VizuUiwJY0xkAGVcoYo5CtPDRCiaR+LNHA3h7D/+StoJ9JOT4qMMj6tBbRrrI7wy93xefb8DOWMFAJjKve4XEU/oeOBtCIHvoKEh5Pdfp5Ciqfn7bo8x2wKbmKwZhFWLAgRR6rKpADzzCSY0/hcD2DnIhwbjNWsLdYMPrwJSthok2GURjWYt5lF/ycVZ8j53cH+fIbfLBYYRCt4lPVEUOCsywDm+OtvE253mKtNEdedqeMYYJmQeU3tBsGVZ/ugGtNGkzdiDMbhwAPg+G5NaFEPAy2gNwqwmjTWy5+hJ/g+VQk0D3GSnlqgGzERpczjXFYalbIKdBD5KrWbHFStF2fR6nkQiNDZAfwGo8d6OHb27Jis4SM1w+tviOtUQukK/gZVVTBLFxh+wYo+Zn1o+oHGMxqR/7ZjlXdHUHfhOaKIFnq+cDTcguuw0RRgJprC0r2UMlifEiBO32YIiSH3HVQdh3grIcg0gMuHxy2Qfhe5uRDbJjIA/q0UhN9lVszBU3PVAQHojgqCvQfVmManzHDwtQicDoGWx/eHW17JjDvnHX+9YMQoRrP7T5muIkpebIpQHwnIHuw3XWDeZFerBI5SoGV8P9Fqu2Gbdd8BxbdM27MnS66LeDLe1zeqpgvLz2gyjPA1NByhpPcmt5lfVvI3gfSXTgAoG7PLKmyilQMlKfIFlYYLHIQfNtAtMpbRxXcBwclF+wO8GplYfr0PuONfk22uVNiGZzk8Uz036rCbzX6SMqkrKjnKTYWPNEtbA9kKgPrz8fVGlnOkovVpeVbs6NNUJts2ZhmbdO00K7cf79VjEm2r2Ca2s5Fc3vm6ooBbaqN49SEewiRIpJoh/aNyUlhBjQst61p1MylhMl4syDBMVaTo8lMQUZy8beGMOpw29VT3raWzUYx+FdYtf7bh99JleNnzIjZEMCXYgWHF3dDjsO6Zx+H0HcI5tass6SyYSea8v+eXUWrbkndxk09I+w4GGUYP5LTFPZKNMiAQkiBSkgrWB5v77DMl3AZSJoQBFtyZ8IezXC7mnDjNWc8V7vEary3C7IF30hibDr6sMSeWUNIT3jkMppXzwR07ek1V8IkHlcwiLkAE9ZGgnmPMgGpr7G6oiYqTiigVkFTTWkQ+L5U6IDahePb2bZdJGqYUWUgnfL2b8EBXsW6/XUGXtigvNAgp24AydwVUefAWFto3Y36mH3p2NfVbcWkHWfnHzptPbCvb1U60+gJtmsmc2zxGk9IuRtkA6hV4FlBcLphNUvUQtESKee4Xe0cwoYheSeNRRG2UTpLorJEwvKrrZaVpezp+4ugqA+CQdKEdA8fETDHmSjQ5hyZcMTFuS2FtnnlH6ioRW/fmvMwp0mYz7PNdVg1jnt3SjOdytHTRk7d0/8M2ZJaZTOi0Df27oMsxkN49qBP0ywU8WSVXfuUlD+sTzExuZ94kuaquJ7WnPLT45NfB6eX7GXLJFxtcHPoKJAVwbomONo/ePHL8Wue4MvdzWYcumC75rfL8zfBBzkKfsdjeTUZsrUGBrjm1mxp+/BQliVd5TNdXPIROpOTzjddUXjezZ7KM6ZCbrOhXi66X4vQ4pOCumNK0YmI/5OgtMGIpVB690msEdB27n8ACFSmOInULOqmLcyUFNHM5X0QS2d93bieAhMT1jpoTITpCifb40OIqd92jXQG6yO/9RKlXa7Oa76Yh0pjKAFquvpOT13XLK2bQe8FPMscy6am2QbpZBAmTC3eKq1wmy/HDdg1M/6O2VajNJyVRxrKpscpUAqvRJItm2dtgafaZBPN2e3adOY2KjuPOXg4UbcAvEAlOsuDTN3LGHSUnbQ1FmPZ8UBXI53x06coSff2C3EWNEg6yUV2rUI6vWvFpk3SULujLdS+1lBXNUtlbqwGU9pUrKeEdE1tGTnzoenOvSyGhPu5JDbuUU13Ryo6hF+HlEu/f7b3ctiZPr1MRKav02JTTzebL07rGlWPoQFXiZra71q6ii7gaT0t2HG+rnEarePAWPMUV/s5KO+MS/MYSu1ESPP4Q/OIQXdpfkvde1km7lffLqpybS89bRSEdpZntpVMttUyNosM66V+7ZV2fl2cU6zG1WFV5ZZbWuXWN7XV2nilLW01Hs2Cic4Chu7qggWZ/84sfJkLb0m5tmX8WnJxzWRTe8KnO8nSlf9YkHBYlhloDd0343QcPONYlQ0cuUGbejxlSYCjCi80vP6m+93hFnf7qa3O4hJ3ZaH9udDs69dv73KuxFpgjzQMg/ZtGnOU3j6NoavyWsM2JV+oglLSF1Wruu9iLguAFquU6x07VwuYc/A9t3wOIUwLQL5jY2+YutjYucWQDILqwI079sEzOzjCus7gCLQ251ap9oWvWSxneGJr/lYY+00NZHvZokcNLCIET/nCBDoeFTxStI/m8i+aa4pohMYUdDqOZ3kD9vD6MyR4OU59dIqJPDixKHMtBSqxFe5/OFr7klS+803bG2eq++CEOTzi3DAbpVQDYAqb4KG205ix0PoczcIbPE6/4JbS3JYyeHeu0mqWeMKowMqHkSzuJMcJpv69mh9ZNss9lJWVf7+VLTuojl75a5FHeLxgL7iM069uPdh7cOB7jJSvfz+aC8CLpw8eUdaGoP0mM09d7D9UJF9nnkV3hbkTvXwoGbrONCvf6OXO+ZwzaP7yo58667uueelSXACvvpqRvYuXZ+Aeb24XAgxwkKePvMXGXQV09Z+xJunziQPRp2VVd1XvNlqW+D+l+uzG8G0HL8uyrL8LjI5ms6IKI1IiskE0VBre7RXoBHLtXd8r+KjfcgSc7L7tcFhzTqgMrU72/X9jsr9LRHkeo0GaZ//WEkmGIl2gbm5pxGlqNMLQjgRjjsptPn7tHdHFZvDxE17P93cq20J3j35BrMUEL9HumZu3bSpwy2YOjrdhgjNSR0ikqTlT1ZvQhddYzQ5fnGvVIh5nwItjlw++7+roy12xWynR3evyLm/Gpe0i7xM5TQ2q6CXmsCX27MF4TB4PvNPxveb1g7C/RDNOeXQMs2wEsHAmdLS8vbvmx3VAPlU8uERRZAmynKiCbPxDx51l3imwpk1lr9PzCwad6x5NAGbojTO0FwTaC9/Aohyre3sD1pBhDIbBFqg0acLIYIQTDTIRyu1+wFlzb9jDwHT8K14vh+TAC/z+xhEpV+a+9rhw0AbHsIahiZtzRhuWBEZjGDweycCMO75/Uq6kIK1/Mn6pQ69c28g3CkSpZJxaRSJCUiSgMRTy1vjt/13xs7qm9JfqJ18QXBmqYVN2shF8zfeaZ3hqO1D4d1oW5vsXGKFNwC4vJXEd1zUo7x/ZMkHnbbK82jteuLX/5cq+2C4P6muTA0Sp4qpibbY+Ji2lbMgm6ZPBxzf5UZoajyix5nCOvwQzeyFDEgmwbgaErxJ4+Uqc3pnXQ9hy3fopoX6tbpxnaz3945hl5UEgdN5C8PllVb4Pa0+ATGCJboN1d3d3O4Ie7wDKu6av3n11dnz65vJ0gH0eKhe6YicSy4a67SJFTcZsP9g7eLrzZIdu0cpSXUxF4sCD7zpwzrCVyjDy94xyn/vxxo0fb9zY7I0bRgPi5be7lMemk7Q5uZm8i3/s3R5QYBf3cYq0ujt5r28usUH9GvFxCC8wa4X4E0bG8FqCj72vXzHI8i6PHx7wZ75imPZ5RScaq+s3O+X++77Mo5UoN7hJV+/0MHd/9dg6WBnwx76ZYwEoNkC1JiT/Km/qWIBhmQnZDMU/8VUXC5DpzD1sjJxXQLb87RcLYHRfgrExWN/hhRgLQK9F1jeG/pu/EmMB7E4aYE24V3gpxqJ1Zt+Nse7sm74WYxFsztsxNmbq/6M3XiwgSTOPvSZh/pnvvFiAnxMh//6I/VNferFQnzm5ge9Khk3ferEAiSqn8V0x+KavvVi08OzbLypsPuGXXHHdDgbTbMDmcfbsjzdi/Hgjxo83Yvx4I8af+EaMBXqu8V4MT3tzG/b3nGeNjMuDmxf45RQDusJEe6tI9w1Fus0H1Jn2UTJ3xq4HvRkE/BcBau3yV1xHIKl/K5vzk84OZZjY7r+AwMPDw/8BMZ062A==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztPGtz2ziSfwWlL2vXyfI72fi2ttZjOxNnMokrduLdSlIWREISEorkEKRsbcr//foBkOBDsuxka69ub2oqFimg0d1o9Bv63guVCTKd5jqJe0e9N9rkRsgoEkGmQhXnWkZGmDyBJ6FjkU+VmCZRqLI/GXEL41QubnU+Famc6FgiFGGKNE2yfCCuYLAdY+CFodmZCpIsNGK0oMdImlwUaShzJXI9U0LGoYiUnCsjkiKnMT4q+VTmYpEUIlQAV4UD8cEoGvVHobIF4JHJGXyRwdBEjHUEH3khoAwXNbnMC9P3gIp8kaq+UHepzhZ9kWRCCqNkFkwFTJ7V6MhUGskAcJNiLqNCMT46F4GM4wS/lyEzBNcM1VgWUW6HImVhAnN54LiwiGcKUDf5oNfvJanKiInnIWxGkMRjPcEtOdUTncvompB4lyr4/qTEH+ZVVPeOPn1v7OnbYjYCJiTjkvfAGfNNp2IMtFYbNxDHIlYT+DxXyIUiRmrkKFKWgDEsDxsng28IYbgzRJQ1LkG8h4cYsIDHZDw2KodnJE0Dor0jmGtUv2eCqZrJ3tH3HjIdhuo4VxOVwVjLrN7RTr8307GeFTP4fH/f/+7ARnqm8+aSdVp/l3c4UcRdNGcqL7JYAI+RajV4KoK7NaxIbgDCSrxesiD6kgyyyCJnRXIgrqcKTlhWgDAyqkZY4P7E/xa3OI7xLQfKgLbNG7ceeaMkgdMW94iiOs6X1RnwzlKmDDAB0V+y+Xx01lrc5JmOJ51rg74AGQQ9Q0LKxwQpBV64Hd2QJlBxCBBQWnE+P20uE0tUQu8Q5mOQ6/dUjJL4iTCER1i198WTBn7vS0S1CZe0s2uJhq+j8DMLBUpwXQU6LcwKqaacZjIHIljN8olVdyAX0QJPttXhHqA4yWYwcUEKHVaKlVstn2bKgjBiWE25SZnDw37tLSgEFQ5xE+pvA5WChh6uJ4gtdoMSUdmNAWioGOkBdl6BlONZy5NvKr7RxhT06K3b9c7iXX9JaDdfMc71t9bU4DYCbBkHCl7FGt58uQd87+Qsjer7bmF7MjEPHtBcS8Tgo8r0WJMSrjS+uAKeiY0hAB1u4qbJWJyfXb0Ul6dbr6+vxMcTb58fxf4aPXDcjlQxUEWWpHKgAvgU6qNUh0e7PmlhEhCQp5AHc4sZ4Ek2GCiysCqqLt+J3T/v7O5vHYrZaRL8FLqSbDLQJhkQ4MHhYHcwO33jU/QkcvD8NJwKd1a916A2wLaRn4QUiuv9k5+1XZWoHOe5Qv2BuN5/QXgmTWKjDELY29nBP+Bc5Hi24KNM00gHNHz7q0H6vrdXTEZfFclwmqGXkmuGViGOTzpXM9M1qc49T5JZmbMbVTmXpduISsvUlJyMbuXCVAZyjl7fWKsoRC1HHxjaVKKnZRWhNpX9IPdMgwlTszRf8IAjMfzc+9wbkrUB94/Y20cfx75hhwLe0I64t9Z6kms3jIsosl/A5hLlgh9klsnFoMU7HXbpvzqrPsT6D8Sf+AXUZR0WgXmIXAIymQOs0smOgEg7B7SmzM9RM9/7iu78Sfg4++whtDJeaCx6dhdMZTxR6yx+vooLygLi3QdOh0WgUBaAKf7xqq1+hWbk4YVR/jJ5K0C59q2SpUCBVBKZIocQW58laluiFLIJE+MsmVUzkD3k158SPzunG3FuzY/YeHd+evDx5HzTh34Wh2kC7mqDxK7jKMOQdJCMLjyJJNezQfkpyFYI6KZyESUQ21gyu+kjTgzECagWqWOWPwhNDPodkdQzU1Ft9d4GcHKz3zBexNqm5t8GHe3vI+kEFnbYYHv4bqc6Up57BH/woLdFtMEj66et8EZKH+R/uUPSUrVFlqF9fcidbB7SR3mMlbc46HQXxQyUpGmuHCsFQGawCCylUojJcZ+sPQPlmmcwCeMasJUohByZB5icgHAEgdlTIE4VbAbi2nUaulzVCp8yrrfHEjW5JbwhMd3OrQfKmi73VWs+CmwCLzPnWQcJqOaaHqDDHemxChZBxBmDAO1HmkJQ5Ul3qetA9GEDQdlNwE4akmpeHyGtqdyOywlWlW14nL/RpMdLfVNa0THFXJbvDveapS4MxSKaYu80wW2DL1fuFeLvgLqXa9ik92+cYK8nERfALDwU3TQ0jCKp54eR8BbiKcKzVqD4yfFTPjMH6MbrgA5UzRCMpFECiSpQc1LiwiTRnLe+vc7vKpehzCUhnmbquMinSaZh7gmcmocxB25sSZ7zTzzveNRKqfTOK6m8OvN8liOY4woMri1eRsktoQWUZBd6HUvbPPQb+d0NftgUzit+3MpAgITTeJwvyek0nJs7ykKCtpylYgP2yoD9i0OzyUmXhjPhvNdbSW9xHfTySpd89/nhDv+HLKAk578eEcqozpIQJa8TnWeEDlulx2EjNppYOKl1fk/Tyi5bPaEc5rtsImNtyoznk51h6zolHjyxEXLS1KmjUKVRssBgc9MGCNZHbvuHyc/Cq4bQA4vaI/K+jP1aObrmspQvHKLXNuz7FmhWGHKA54BQlx2tjhToFjBCKXoTa50oQSZFvHcZ65qmfIneQae69pyoefBfJtz6eos+1DytPofee/j3Zh7cUCjqnuDDzCQ3szAJ2k4Or+yYXtpy73wsUcBDb6khR3H8Bh6yupOKWgcWAS9lWNKAebCSCHggACUlDKORlymh0FhH0hANOeLe6fXynIbHy8FrAeRFviPzLU5uGZSdZY0Cquy15dmzXJGOv2GGtalwQHKk8OGWPklf6LHnTxmMAHJOdoSLWM50ULk6Y5QpHc/BuuEi3RHQhb/KBo85+HixSaTppnleknI41SaN5AIWY74gLDlqV5isPus7m+sFasstby34y1alK2hjMFFP+whiQMkI3kveDMOq1S8pVcZ/Vpp6P0n0ifNW/V6UcBYHo4VkTpo8SiZJgxlfmnkIzno9JBSOgzi6QTBuRLn2g4De2JEdQBjrxzh8pdNEU4WeUWHn3hL+JEg40wNUm/Agk6qnFnn3NW15QsW9gst9nTmz9YN0TzIDH+zjZZeNFCUEleEwq26pSLa/qQUG1RGeXt9sOPG0uqce0FG2GhSmS/HWawhVXtTq4ZDFjXNU+V3DlV1yytve49DauuFmrTQs0YyV3HH4e1x6x85uSS0Wa00M0+BYwseRCqSt3y7ETGdZwyW9hZNZ09tlnMl6YPj9cy9S8SSffu4diZ2++AzeV1rkN+C4KXyF2Uh869HnXt8PK++LfHKX6mwa+nbGkZdcw+Wrasag1DOASVxzSdqWRwEIMJllthUzp+tjWTqJB6jSS0asYalwLMrdNKniguYK/aXmH/wSsDNo7SkGhlHoM2JmA4tmw1zd5dV3MkrBwPEMjy31PgdKWHsVuJJn9nyBJQP/r9YKEExV8A0UfoODbBSewMOexfHRyus8hi8Khup4aV1KIkPdwYnEvN4Uz30iJqpbHFDX1e2Tlbva3jaMEmYurMdJuusUdImOfMVIWfR29sKfBLtMs1psL9MWNt3lzqnzZ7k+0p1UdKxYHmb21y18vMP5Ym+wI2QH2hzv43IOvYZfgj5TU5jfvzwRL/ZfPPs5uqqlMZieB1NIXdTglKZWwLhPhzcVXWXBZAXJfoeMV8VrgqpHIzc1S3izTq1lZXmhblitGK3tEtYwv5gmeVLr4KljXsWRXeLfFLWqFLjUKfAA/tDJcEqOdFjVL2DKXoE2W6pQsaESbI111YYtZcoXBja3juTy7H13LryaWbbeDN+5zisUSc7pAk06BC/lPQz3ssYwcCZjgBNhNEGDMK8DAy8LgxlvLysMOjzJZKbrQzsjuVLRWybHWNlk22DzKq5zLcmqwX5l2dkT23/nkTmox+AerfBkyYNPJf6kjSM1Ac9Th34x+WHfHieJC9gkYK47T5bXG28uzk83hazg1bOLnlT2y9TnHOPARn6UMLNCnS+c0J19OD0X3CEnVJCYhQH2cyjQpuQiSddJjCaAFfx/kRijjCEiLpKLzdIklCghaT5lfc6/UOBcHjUsuWdJxO6BNCYJNIoDDNVz7H8E5V3Dl2PgtVJB53GIbFYUPVKNYSV65EeMlMJmTfBujBkXmIWe2wW5jlDkiQ29n5KLcvEvQMFwm9PcNmHQSoCxQEvuYKoyARDli7ppseqE6/mcYiBkAXOzloB+5IHNekFpamDb8iRIPFvcGQG5zk60aWEmx/nN7v7QP2YWoZudXTpMQbZI82SSyXSqg9/UojI1D6MMw/3U4sbwmw65QYa0gp7EyDEnPM2VlmflVuXQPKhHGIuFR/CJW7zuDndeDBsaxQ6AT/itbYuizsXKFJBB+RGDdozjEUGQorlOCoNaldPOtcQULuNaQObKtVAOel1IrYPPGgH5clxDWz9vN3K6kjpX7axpNGcxbWBdltc+dKVNZ2BCMTRYtyPEdbbddIo5J9ecCrrW+fQqK0yO3cg/gBmJV+PogypyikfICQYYOdZ5rTeAZgAXpj4rTgbg46XK5jpQF5zl7kwAPqbJgaMG1/5I6xlewSXSM2Bmni1YsLjTMvQpC4uM1H2JqyXKWuAl7Qp1mz9OCggMIb4j+FyKQP2HUcbDJ7gKLiitWiqwDo8aHJ5xBtYIM7axAkyoVjvKkltD4hOC9ASU68Zu7/oo5IvKtvJkiz9hBWFWxN2Esm+zTgTlaRMfNXj0UGiHidYgPIY79dDLxhZUb3V41m1OvZ6oDfsYH2Kdd7tGa56J+inQeKXAei8IWniwxcb1h+NNShqgfycB50kRyaxmld6rZrhkqP5AM7jBD5Pp4FJpPkbwRSme6xQFhv4EcMeHzRamflWYtdYb9M1bb1K9zu+DW7/W3wmvI5PsQ79cz4XhrRFgzK37VIU7HDH5MF0LirekJE+KzNzVWlEzdfFa1HmybcDoZGyZRx0p2NeMjfEpuKOcIgVOpK9vvz2cg3h9+e6tuFYjgX7Fxuvr37Cybh0z57CW3UBpMQLJQTeAcMDlxEhTV087VyCjyRqpgmgCRyufzgTmHjHaIMiYoCjvzZAv40fMZ5d7h8/Yu5mv04rhuUAiKEBLNQLwLQvu2zppAeQTuM8uIiHdjD2iqQpQHNrYMve2LJ+2dsf7+7v7avxCyhcH9FftHOzsyOfB7vjZjgy2RoeHKpAvDoMXB3sHh6PxaHd0MNrbV8/3RofPw719wjRfrIcpZV3qzDtBAHcPT/87qPIkC/E6kCrP8tmJLwQbv0ijnh2gsgTfAj2bzfpiY/nh1enh8fzZ+Pzi4rJ4dblIzm6DD7vHf98tfrnJ9Oj3Zy+yVy9Hl38+RqzWIOofPwGrycFve7/Od2715NXs4uu1fr53MMqOX/4xubmL1G95fn338vAwOv716vKglahAzrPgIRMR5S/NIY1cxXn90etwbbee1jo1O1oS2/1cHR1SHf1KXZ1AVRuO3xbjd6YsacxodUS0uxU6GgFadeeyWruiDlbWepakgzvyPt2piqVhf0d8XQ92q2jS+prHcQCI9FhdLI9sOsOLTs9+uWe9xLv1/cAlDtByzwR9ppUp9FY7vtcxa1NmdF+OXDsCUbl2euybSu5uAQfWD8gqh9nVvyOqm1BnQnn7kA1I9G5MNxibJizXOWvuanzrJgKjCiN807uswHXiEWab+32NsYs8S3I4To1gcBm8KxzsXTukIFLIOQgt+l0+7L1DBxxxfQpwRJrbBEMBroi7F1musI9JJHr5mEofo+xuR9a4gS1bU2kubOD9qIQUS0im/mS4Y4QgtJagaxW8ylt1t467tmSFGGa3oFOMfn/fahyqxEm4urVwd3qoYn/fiuxbxdxW1xvdvJwqGXL+HkEcPPLOjW9cFBZsrEqkz16PAfZyrL6fU83uEoWq7kpdeS3wXb1cpVH9RWLRAOuvZWV9OctqnXCaE9WUEOeu7sblbcpPSnELgeCEawsD8YorkeUVaQ5vgN0JxzjuqLkrPBAujZK72sJdG7P7H7wxH+Kq77fFmsP/aJk9h/WyGO8ycZKDlmnwCCYZBWZHo28ORus41eCBw8cveJfwFwrT0GzTG6RaTvB+fs/e5nfhftnSdrIJC7CYI5O4qwG9V7pLn0qE1Nue721zbmzbNrhusTra5oLotgm/3ubbQc0HYSK6fhzgVM0SSyN6dVmE8Uuep+ZoezuE77ZkqgcaYimI2nXSa9/UvqCLVlxM6wbzEARw4yYYeC6ZbvjrJiJfKuZfogyy6LgtqJK6/MJe5uTd65U3wmuJnnaoenFO4QUeEuSln+HikrYN3oc1OEPBy3Af7ggziGqs79zNwyHjKIZiA/SWch0UOiIepDJQm32hBpNBA+yRsBP/skiKDNmxBcj9laN/X9i+9zhD4DL/vdfXV23a/HxDKo1x6DEkizPW1urJsJKDdPDJPtOEXnmocd8oiMJWS6dBZEAaBFSFxr21Jcq/VftZbon+tXpVFwRfhhrUlJNcttZQBtl2Nmv8OytbSOs944+7boc5uMd1qZYVJWMvaKJUqRjnGGuc/mntGebmMEDqkx/NLcK2/ul62f0fkCgMSQyEhqEEn32L6NUSr2ZE2ARM2+mKwYjt6jt3uNoDl+5c9zLaUbAEEPSoqn8Uzp4EmcAUa2vrbm9vB5K+HgDJ23au2X5zfnL29vJsC+fcV15+tZ3ILHdH3B3SstbX29vZOxjsD3YpkkhMPpOxhw8GVKIWXTe6oUrT9v8/e/Pv/dkbqzmw3W6bWszoPkRGV1fZ7H3qzfcwbUCGjwqOvumzeQuKzsn81TIMBo3pNMEiwafe9+8YNn3Iovt7fM23+8ksgo8IZ7K6c79UWP61v6fTyQusrXo/q0PT4QUb07URf+yP46xAxYWcT8Tk3/RzOCsIqn7F54kkrfFrOSuWL38056mr/+jv5azCzfvZnB/bb18hVR1N/1d+42YFCzvSuj+Xkz/nZ2JWUMC/X/Nzkf7BH39ZgW31kzQ/D+Of+PsuKzBvof0FHzLaWo4sXRCDRovn8AVub1YrUL/3w8lfz65sErkeJ3EDj/3gJWFlvPBgN0MmRgH/RQ53TvkLenEQufy1HM7fLJ1QBhk8GvnzBcLt/wFKyWiP
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>
      

---

# List global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-global-configuration

---
id: config-list-digital-wallet-open-id-global-configuration
title: "List global configuration"
description: "Lists the global configurations of the OID4VCI issuer. The service sorts them by `updatedAt`, newest first. An organisation holds one issuer global configuration, so the array holds zero or one record."
sidebar_label: "List global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztG+ly28b5VXbYH7FmeEqUZamZTG1Jdpj60Fiy3RlHYy6BBbkRiEWwgCRGw+fpe/TJ+h0LEABBiUqTTtrYPywS2P3ue5d3LV9ZL9Fxqk3UOmq91ja1Ip0pMQ3NRIbCM1Ggp1kicYEVJqCX70Ynw4/HI6GtzVTSFRfwzKrkWnvw1yQMYi4mCzHOYl+myn+ejtsiUjfKpiLQiU274nkkTDKVkbYEXMxM6AOGSDmwjSS0AT6RIJNELtyeX1RiABbtTZRnEr/bardMrHjPyAfOGAryd6KnOpXhJxmGKn0XK3j/ijAdlxEBgFgmcq5SldjW0ee7mqTeZvMJ0AgCYYzAshH2SsciAEpiOdURwQE+ge8pfL5WSGMWJUr6chIqcS3DTIkA6LBiIr0rhDDuj5F2jSh+BiEs4EsEVMBXEwRWpfA9UT9nOlHAFey1qt2yHkhbto7uWukixqU6StVUJbDWV4HMwrR11G+35jrS82wOn5fL9l0ONtRzndZRVnl9I29xo4iaeE5UmiWRAGEj16r7awkcMFVVzO/ogwy74kOkgTihfRWlOtBMBhqClZE/MbdVWwK6MqtIFelMW4EUKTS6TzMViYXJwFwjn9/NQB8qaTMwZ8RJFrEbFEYkdEQPwI5SdZvm2FGIfiMNCFCmYMttIadSR2D4uOGGzI63w+tG6uGZiExa2TeHj5XNqrKnK14rCRaGz5khYbI0l0MNQPfH6Meo7LNokrYsDXClcCFucmHJDCCA3D1wZXGj05mQYqJkAgul5ymLhnClopJ4G3ZE4vnZSFypRVXUqbxSdrMmg8TM6a3bTMLR08gkqkIxBCGDanN4OrjUA25Rb3KDgiaabEAR3NRsJoIYGJ99uBC9690eh5Ke9MGhejLWsLt3B3//rhYjf9lzEDoAYSxQf0AfSXz8j855NmEVjHx4x2z7KgZ3wiBJ1sTaLfNVEhZan44yRZ6Hoo/BwlLgBHSN4Bn1u2SK8G8AudDBytwnBthgsHZlA00MzzMwO3UL0bLNnycqNNEUsQK0ZN1c3SJkJjQL5VN4z6KryNxEJadto3qqPtysnNx5yA9yoG1CVYVA65g6ForwdRCoBBbUqARbmIOtsRfjt0DqkFX7/cXFmRj2+0XoZSGtYm9VtFuFOJsmOpq2lu2WupXzOMRnT589O1QDOfT2J7vBXr/fH8g9/2DQby0vEaSNIccqi0B2+338U42GuSUA2xx170vVHPuA1SwhYeTBmQJYlCJ0Gccheiis7/1kEcVdiY84weCXaiZo2pAi1wh8tT0lZNacxEHLah6nLt7UI5uYSbSCKlBSVKrmtiRwM/lJeela8jrhBENFhYywQFEp+NB0YzGzVpfIB6sSJKcqLu2vm0KdsveURBtSWiOKShyYu6AJouMqgkSnMZ9cu2jqCiExKtyIw9s8LzyArXGDViFyQLaFpLHhZZ4IYwmO4wjG/NEWXOqRj/oKYlwpe1qUUMkPnu4Hu5Nn3qEc+EMFbrArJ3tDz0dvacT6sDA31gf3qU280pQzCzH+BrxNDvxBMJS7nWfenuoM5eGgcxjs73b6/p73VB3IwWS4j3waqjzflSxtGzZHa/xRBXuSlwYcKufoZhQZuUAmDmsWCyR4EMAQnAxPb2PtZB2dyEXZrbjo2+hWqtiJJaA2vngCQvQBxg45PgbaFR7L6vAhNfgqaaJLjCJfX2s/k+V9wFcA1SvHEw8ygIEgmICyS8qregiUPVbs9VcxxZWAYqrRQ6DOxmo8VIW/gExDH4umijr3+hU5vUjAAlAvW4cdX9s4hCC3Cg+54krceRLjQFHffRjZKjMyvAGBloI+8Mx41yMPZ6yH7KhOHlUeqK+KrsoUtTFg2Fh5aH1+7il58DxeMTNih3ujUuhzUkmWFhrIuFuQ9eL4bHggQhlNM0gSUBtOi+zRIMgnqjvtirGKOq9ejHeqIjPQ1ThJsWbzCMkeAQmFjQapq9CwreRm2VxGnaKZKy1ak6MjXdV1jLix8ZsmBvzh2IQmeQR+dQuuEyIq46tVkq1Z1Qp+Lq6/vKR/ILBK3HKPkSZscH4DaqhNihqpyknp0781UvgxG87UPOxsr2EVxzuWLhjqzNxsQF4bV+DqcZboca2zUNWUkIePifEX604H+7dIUe9f577vul6B7JXMAwiuEWvvCwtEO5k4gnYNTKV2QfhcNYPlezPwK8dbaUMl/jJFMkixtYMKHrKJ9POV9E7P0TOL7EdGLMP0ArT9sAieA89kF7m5rkC2MWT7nDOop9QTHeoUhL1cluvtzyTsFc7LihONENTDBvNi5RXMz/+i8UzqTFTjDttPs/gu6w8pa1RxrsemcmRwrrku+8tKwnzPnJ9GXrIgsO8LpAXHE2MgD0drLNMwYZwmmRq3y7MTbk4ZYrkEQvY/Qg0SaIrIx6UIPMqL/ycuYe2UM5YjEgxQY49bFI3f2BwNega0+WzsWTozif5F5uwgf1gFLTYMuCotnJ6rTmo6IRaeWClZKNMj3xVL5Yz6vIwmJxG6E3JNcnqut9p1MzXY/nJdpmytmKlVM5qKGcjUM+OXaz7qy7D7zcIQZdk6Qi1siv0kITNNZDzTHs1SJgxYzBkye1epGI+zSajtTNlHlBHkeM6rwOmQtPGquqsGsSLHVwlp6hoLd1MRjkY/t3ztHwEP8OSnmyvql636gg8uy618fV3d6rmVH4EVJEDzw+X0G57NitiEIRKs3c5mG3GOQNyvjDYXIugFimOIpSVpnkZ+bABoxR72gWhoDMFheAiQLzqNUOn+w2H0HAIl9/c3oPpZQYErExmqgFLdUuHeaAH48G2JiBWpW9Rz96jelXf1YOsnkNy+DPZ+TfzZnnaWiUsnZP04hs3FQzSIwR4Xn0zQ/h+AoP0yQQd/AIIOMHsBSQw2DwVb2CVkYvSKTaOeh8LMb210FuhRfo5j3b3+M/lu5gZbNikYu/jh04Xr+kvhmmbW+UihKSzenwJge8PIhcbpdLoBmB+icRuJOw7mOVvY/gZBIzcvTTKXjZXo/ZzwvuJQyRkQnVagpbqYKcZX2gddjCHm0wBhfLvfPxxXefCN4oGbN1N4qreaUKzVYs2GgcmEa+ALPFZ5rQOVQt0wis45EWxRZ3wPFSxN7KGILx/RFKcLzpKYNO3qWpdXpuiTEo9rafBJI3JUS6ICKClm7rBnvbKoVEbH0AdyWfQYus+VO39OHyyUKti47Xzy/uWxeHowPBT/+uewO+ju7jQUTM5/Ybmrkah2x6ESODDKDJZP8CX3S64l2cg0hLN4e4++WBHuWjQ30LdZHNPJ+cmZOWNGDofDw50jPrzLLT+kA3rE+cXZ6BcZTr+QedkvDojyiSUSUln3IIIJtQuun0M/dQbPmv/GoYfoZYKueBcEeIbv+g13ugeOx7GIYao8npNBWfGCjwXpJbarWUKOpNG1AgG1OKCmIRZ+dc0AIa2Ilg5VnHAf0TG8Kc4SV2yUZCnmIBaZmmQhXD16Pej2a4wcue+uZ7Nk/niWKh084A9eYt7BY663SkHoZwMgrH8l/nKeowrLUXkhmCaev6D9pWWDrthFG1q7ufK1TFW4aBRRZKCv+V0dzftCOPLRrTMeFysc7SSzHq9TRQHX7HtuVcn56s1d3i9LwQEHo9BEAT2K5hjgqqCKazbg2FiL0wLT5JxQkvPtk4cr8A+RviVh2BRAVCXh0n59WA00W+FQVJAPDoYH/cHgKdFQ3ID5/WgIJQhrbnwazW6ipJZ6NB5jNh+2bDicuPfAoHFKvt0k4N6W+p5+9d6Oq6z7sg4wt1a63CVe9Mlv6zSVlqlOaSp5tlpVr+/cyeZZdfa0yfWOS+egorCElcqQQpPKcFRrVTfOFHBx6XIOtbhCXkvN9U4J9u5+Dhxp/TXAkWi8rmR5XJnfHlr5HQ5t6eHDsN/WSM7vEFWkgS40k/YsUdfaZHaLLIAnSHifgi4/QGhJ1DeWojdDWEORR1LA8rY6xXwkhggnm3XoWGwul3XvazpOrxjiZbtmiATCXd4AEvHbkC8JbH2iXyZAJYlJsEZDWvHzSYnDNeR1g1/tbtJywfuQAuAa+KbpSzH8fyHxmCTOUJLu/h3yvqyf01ApVRl2Q2jMb5zks7TK2WjtNgnGybo8B39ieX6I8jBMMbkqmv0/talRVokgDrpindDUZASbIFdniU4XdF30OV0Ig4+XeK2Ry2Kc6dIT5FpO8V5py11HFXwfVTxhmx1+PN4BBNwro5B4ggm0TOkOKN5QgC+l62g+w+mwsfcwg2u/x3GmU72R00JSkZGmi60nam4cn5g4kxCvQ6VpbI96PR/edWSsuxoabijwtGmt39k8S4yfeaUadg3MQxDOU4yD003bLb+uE3K5UsA52iGbT66G1WybH2y46FWZuq8fX+V3EFe3G4urOTyadu3UuAJnnN+qzG/JQSoK9C1kUL5YyDSKsXgC8YkvqKUJZG+SQSw9tdMWfGBaAXsk3MZv8U4eigNvPX43prlI2eDuWnxZM5+NtH74dLHOW7lTjKW1OXmuo2OacWBfPZkoJEjOT1mTNrQKx0a90eRDR4HJo4j0KIpAuNCoW9e5/m2lz0Il+tXqUdUQyjZU46bYRJ2C9rHRgMIZHR8krPEvXpJhFqo3aR53jITtS/NGqFhsgaJw67MdpCg1ngnpNBeSElqVor7QuoT2i7s5B60WNV1tmjDyQe41YoCm3IWN8j0DPgoA94AuN/Fth/jVEoetIQ7qSZ1O0kTtp71j8fFYPAF7ABMbnV68FOcnHfgGTxnb6PydGDzrD/Y6+2J+Yrze/OR1+bApIJOiYybIBtDyq9UdFPA9CTYhdrv9NdXd3Nx0Jb3uAss9t9f2Xo+OT9+en3Zwz3JVe6/UicLyjZcV2gPQ7oAB1u32d4fdve6AqnpjU2j4S/Tg7f/Gi2B1Zygluv+rn0Q4h8RT3F4cSoiAS6eYO5dRPreud/mSKCBAsVSyiusMS61jPbNAEJ6B3BHQ3R12CR+ScLnEx/zTAso3wB6Py9zd2Y2y/31/ZNEoDTzSK/3WgrbDA85SWxP+2F9M3ENK3mGtKLnEL4nmWTaWF3kWe5xwv/624utvK77+tuLrbyv+i7+tuCfMrf3CohJ5ec1zUkrp3VoPuix3Sq9OL9xssVr+860N9wFjZv4qWpRg1zsBJgH/R4Iat3yLfgSW+l2xnN9s3FDUzrwa5XEJneS/AaC4VdY=
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 global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/global-configurations"}></MethodEndpoint>



Lists the global configurations of the OID4VCI issuer. The service sorts them by `updatedAt`, newest first. An organisation holds one issuer global configuration, so the array holds zero or one 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"}>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={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server returns the global configurations 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"}>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 configurations for the current page. The array is empty when the organisation has 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={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 is not the same value as `globalConfigurationId`. Use `globalConfigurationId` in the path of the read, update and delete operations.","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. Give this value in the path of the read, update and delete operations.","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","nullable":true,"description":"Default cryptographic key binding methods that the issuer publishes in the OID4VCI Credential Issuer Metadata. The value is `null` when the configuration holds no binding method.","items":{"type":"string","enum":["did:key","jwk","cose_key"]},"example":["did:key","jwk"]}}></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><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  \"globalConfiguration\": [\n    {\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      ],\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  ],\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 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={"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 holder global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-holder-global-configuration

---
id: config-list-digital-wallet-open-id-holder-global-configuration
title: "List holder global configuration"
description: "Lists the holder global configurations for OID4VCI and OpenID4VP flows. The wallet sorts the configurations by last update time, newest first."
sidebar_label: "List holder global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWelv2zgW/1cIfdkG8B2nRzAYbCZpO97tNkGStgt0ApiWKJsTidSQlB1P4P993yOp00cyXcxigemXRLLIx3f+3sHHIGI6VDwzXIrgNPjAtdHELBhZyCRiiswTOaMJCaWI+TxXFNdpEktFLicX48/nE0JFRC4zJvD1isSJXOkeuQUKK5okzBAtlSfZIjJbk4RqQ/IsooYRw1PWIYKtGPwWc6VNL+gEMmNu/SQC9hwFZPKCz7mhyRd7hj0++tly/N4yfF4/CshkVNGUGaZ0cPr1sSX0xzydgagyJoqFUkXArST6nmdWzozOubB0euQM+JvD85IR+JILxWhEZwkjS5rkjMTADchFw3ukMB1MUQKOR/yWM7WGFwFcwKuMY80MvCv2W84VA9lgr2adQIcLltLg9DEw6wyXcmHYnClYG7GY5okJTgedIOWCp3kKz5tN57Egm/CUm/aRTVn/RR9wIxG7ZFbM5EoQUDlKzXrfyuDQcdU8+dI+0KRHPgkOzBEeMWF4zB0b6CAafGkmH0C3cyq4tkpHvnLNrCnMgmuCHIGL9MiXBRNkLXOiGbig/bYAezDVccSYWvKQEZUL536lKxEuCn807MEUp6MSo508IEFqCNcdQueUC3BQUzm43Q6fd3KP0SGkaexL4bGxmTX29MgHRsHDbBRagYjMTaGHFoHeL+IXcVsXF3boujaIFMmarApl0RwogN5DjLkVNwtCyYxRBQtpGDKNjnDPRE29O3YIcnY1Ifds3VS1ofdM77dkrGRqv/rNVjl8LqRiDY4BPiSazZ/TxaUhSIt2o3sMNOPWB5ilC6ray4QVYHr16Zb0l6O+A5Q+jSCg+jTjsLv/CP//ydaTaNP3FLpAYUrQfsCf1fj0392bfOZMMIngmxM7YhmEE+gpst7krFuXq6Ys9D4ucmYjD1WfgYcZkARsjeTd0ZdqjvRXcDjhceXuMwliOLK68oFdAqc5uB17AMzsuOcZS6SY46lATW27q1+EwiRyzSKAPQFYdy/kStSCtoPmacbwbuMUwWPjoCDasUc1Kdh1jjunFBLxOGYKFrS4BF9IwddcFONbTHniTPvz7e0VGQ8GJfQ6JVXY21TtsyBOG8XFPNh0AvZA0yzB316+fv2GDek4PJmN4uPBYDCkx9Gr4SDY3CFJnUGKYxqJjAYD/NdEw1qCdKj7dNZFiSxkCYP0aJYlGJPwqf+rRqKP25zL2a8sxJSQKYQ/wx1Li72pstpKlaLb+ePnQ2WBdLjqERqCwGYR6/WWGjoBSzPj4aiGocgQOsgOkblhqd4lUpOx9zs4KtDVa9UjJpkU5znsMhCG6HDofWwJSfNAabMLrxGWLadNHfNo24PaTF/b3LsjEx7wgyaKpB5yQbOuBrGa5ZiNlh6LXYK3YvsgdOCYFmUL1WS61yMAfVC2muO/PIlHs9fhGzqMxgz8fkRnx+MwwvA4QOVpZewtCw4q4z23qbKU3+f2jAIW+P2YEjtFmYk2jRj4Qa0g0E0JZ6+iYTymo+7r8Jh1x/TNsPsmPhl1B9Fx+JK9osPZ+ASllbbsvKy5wnPEnGzJF7latogFB5Epop71ycJXQcSm7MiDzrMMCuxzwC8kS5O3IlTrrBXLMykTRsUWLzbHT43K2bRTD0eXjiBYHTGI5CIkqoPIdQFyDe0hsQ0iYAwguKiW3xhqcj0B+FJgqD31Y0NPfilaVIMLC1DCjJkVQ+RYAVJUnCi2lA4JibbHEMDB8L7J2PHLwcAyFgHYh+aTSp4Tn24x+XT9wRmjpiTMw7rwt8szqJLIqDcg+CAV/93xc+2wkEQ5HlCqscY81zqnIvQ4CR9o3TUh163oWpdJAjKmQ1DHMZQLUG8UdWEBCoBpDUywFaBZKJnPF3ahj4XylKb/L4zJ9Gm/7/HSf+iFMu1jssX+JtiUefMq1wsWNaT2Quv/wgMRU6EAcMT36PTF1dl1h1y/OydvhqOXR75FYKWSm7vOZcQshjtFb4FCAhVSDRKgrhBFQ4REfYeHJeyMwUlO47UGtkduGHtau7bGAO05Q0dnpqYk15TtAsYH2x6Dc6cZeVEFxFGRSNvYAGrU3peixvHDV+NXg+HQxYJj9E/lwSoolREC3l5ONvUi7CtmzsOpZA/0HkbDpzGpCQ7PcvC6Hev6vEOZqsmBrdeS5DK204d2IWO4sXF3Va1vFxNhrrAMhhXsGdB57lbb8ouUBq00D7wZCRln0iqt9tG7xcW1kYEtyQhdQtGN04867dFJQRx5/RbiyDQOUTTEPThRMdOocBwOcD8+Tftji+VistHQBkbCguoryCJc5s8BrYmIbDdsWzKIeMX+hmCVeQpbRxQxD6d8ZA/m208QOK5oU7cZd4NtR5MGGgCKCQNW0iU2OkQD1bYL7XYQ7m8RGo4Njo6CuUYUBMO3sWt4nt2r1I9lSkmFUI0S4vNFTSYQ8XBfU+3e5RulxsYW/bbI7ygHqqT4E4U6XWQ56t/PEkFnVvrtzq7RHgAu+u65Q7wVfJJr9cSlkRrToGBbvcO/sHo/CeqRmEVbqjn5S3ueTWQCwBTrQEA6e0xLR9gyMMgm3KxtLjqzsy54vMOJ7U92EIipzv6CUtM5jswDP28nbuBOXhRt8fkRHOCGAqgk4G4hcVI/t+Nt7MLgpTZp871O10VAH/M4j/oObPquw+s2oQnTupVn1+j+gqXSi4v5F2v6snyN4FuXZrzH54oK0+My2J5KXykZ5aFrHXaTeYoCFBFzLO33bNfuc5uRu8oON+iOzosKa1RDGPfDnlFWoybZyiHllLWa35bjA98XuP5z2qAzLebGxRwQ0lrMHwCe3OjU8Uim5AVglyt4jYIcY3WQ0ZAddQjrzXstsqfEb/wBp46oDpzr/ji1XWzd7x4DN45+J1VKIYaDf3y53ZatNqqGsNC6YM9R8jxjc9ZsAkoNWgywGdhuCMr4RrvZZMhFLAswoaEFE0ANjrb1ZebfK3uWJuHvq5+ajlD3oZY05SbgWy55ZFsfaLcyO6bg+B/HAY2ZlgtAmzI+MwXltb2HqmpbTSa+sYRgdQ3RUW2g1d4I1Y8ujyij++oIOTIylIm91IOEhV7FBO7RPk/97hsmI20vyzp2YuEGvEs8YV1OOMIae7m2HmNgGVWR7lp5OejB3SE6c3pNW26/HJ+Tz+fkBfgDuNjk7e07cnPRhTf41Z02ubkkw9eD4XH3hKQXMuynFx/qrXZsXcqOBSApMKEtWhfBBL4LeoUWfst0q9WqR+3nHojc93t1/8Pk/O3Hm7dd3LOp6vjKnKisSIZ5aT0gjUjmzD4ajMa9494Q92ZSm5SKGj94y3lo9NWOiVra+/+7xvXBhddt/SyhgGYbr+RHnyS+BsuRG3ADcZStkSh8y1frDOFhd7q4wxXaIMXHR2wjoJnbbPBndyNqkwgUV+DB1ch/ryb/3LvhnWq5xwxQXRHb7fCDSz3PZvyPXvQeYKVowSpO7vBFWeRwpUORmv6Ycr9fCX+/Ev5+Jfz9Svh/eCV8AOa2LoYbyOvWnFmj1L5t9Zebehf0/i2WrtTXtVVNf29rev9QGwlSsa7Rbpf3jgX8iwzt3PIDxhF46o/lcvdl74ayIHarUR840vkP4gxzDg==
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 holder global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/holder/global-configurations"}></MethodEndpoint>



Lists the holder global configurations for OID4VCI and OpenID4VP flows. The wallet sorts the configurations by last update time, newest first.

## 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={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The wallet returns the holder global configurations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary 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"}>holderGlobalConfiguration</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Holder global configurations on the requested page. The array is empty when the wallet holds no configurations.

</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":"Record identifier of the holder global configuration. The service makes this value when it saves the record. It is not 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. Give this value in the path of the read, update and delete operations.","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.","example":3600}}></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. The create operation always returns an empty string, because the service sets this value only through the update operation.","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><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  \"holderGlobalConfiguration\": [\n    {\n      \"id\": \"665f2b8c9a1d4e0012ab34cd\",\n      \"holderGlobalConfigurationId\": \"b7d1f4a2-8c3e-4a91-9f52-0d3c6e7a1b45\",\n      \"openIdOrganisationId\": \"string\",\n      \"supportCredentialEncryption\": true,\n      \"refreshCredentialStatusInterval\": 3600,\n      \"redirectUrl\": \"https://wallet.example.com/callback\",\n      \"requirePushedAuthorizationRequests\": 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 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 secure vaults
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-list-secure-vaults

---
id: config-list-digital-wallet-open-id-list-secure-vaults
title: "List secure vaults"
description: "Lists the secure vaults that you can configure for OID4VCI and OpenID4VP key storage. The organisation must have a deployed OpenID digital wallet."
sidebar_label: "List secure vaults"
hide_title: true
hide_table_of_contents: true
api: eJztV9tuGzcQ/RVin2xAWl3sAIURBLUlJ1Wb1g7kOA+JAdG7Iy3jFbkhuZJVQf/eGXJvWskp8tjLi70iOcMz1zPcBjGYSIvMCiWDi+C9MNYwmwAzEOUa2IrnqVvhlm1UziIuWaTkXCxod640u5mMz+9HE8ZlzG4ykPTzlj3BhhmrNF9AyO5Qn9ILLoXhdBFb5sayhK+AcRZDlqoNlMIsFgthecrWPE3Bhl/kF3mXCMNShMZEAY4v/eWwAr3Z0x2yiWUW0tQ4vOtEREltBbAs5RYll8zkWaa0NR0mlT08t4c3N2DQDMU08Nhtlz7w+2p+INMhIbfqZJruZCoDL1hYR2dMpiQKGMttblB9DF4rWlwdJ/Nnw/5g5jHjZ3+GKoJOUB2ZxBhFD45iOfbO/OR86Rwc0/LUobl31qJ0ebsJLrYB6qd/qMOCtPTJsywVkVPf+2ooT7aBiRJYcvqymwzwTvX4FSKLyjJNYKzw2kx9U+Mw15pv8Ox+8k0PU+5oxEKUFBaW5tj1+ypvJJRisB+E8ACqiBv6BFq/AP1djGwyDtlsMHOZSEjFO82lDYXy+x2MUL35CzeYY0pn1eZZvfnhbnpbrZ/X6zG3/JFjXjzy6AktqKCDzJfBxedBZ9g565w/4MIzX2YpQh/sOoHE+mgYY6wWcnFgy1gY9O2G0ekyhdsuKu4JatMKD/iQdoLarNbGh5ynYi4Q9J2mcp+CXokI2K1WKxE7146vulferj3ZpjUvXYxGCnMt+WMKzbA9KpUCl4dhS9Qaa8fqHGZY6yCrZmYgxcRxtnujXbcyBVgNNteykqxbDnWjvXiUgOngbkc19S0XmsB9pswqYtJE/bBrn2sWi9/9XoEUEEweRWDMPE9TKqkEuw1oSmiSP+/3f6iYm2hAa6VH2IjIPPoeN8BgjL5f+LX0saKq3IUAd0fUH8ndOiWusJ8KmeWWZVyjVy2q3O2O+OuAd7B/UuNcYWbGHVbU2FHeKY+W7BQece2P9cl/l2s/Sp7bRGnxJ8QHrnn1n866Cd6nJWYSNRHAhkHXtHyEQq7Yhd2g0dvgMhO/AX0+7Drb4Aq4Bn2JDnYrZDVfGPJOwefMEzo7KQeu0SlegBrY71ziyLUkt6MYokwUTQQLcL7ipDHorYY9PyL0iqTv+qTvoSuliHs4vHWXlSKaELwpxmFtkQgsVWEpnst1imuJtZm56PVi3OvyTIRiUTTxgMzbV4B8EOeRK88X1Pydhil6B6P1krjx220gD3UIppSJPoHKQNSjil/Axk1X+RiW3fwiuCyKwGX2Aetc3k7cIEylgo4sCsAzDPagvGLd2Z6eGfPX+DH5EScgDXPxjL1+LWyChx0kNmMn2KH8jGk1F6nzQcYjOO0wCBdhS+0FKwRfI/dpckcXwb2ZhUSmzZTbBo/u11scujiWb/Drp7tD2xzrMKuekEwzbkwJz2sqMGPFsD0QrPKgK3/H2U4gqEqb4hZQhQg5V2Uf4ZHrI9gwBMW2mOl+ruNZhaQaGA4SoZlDLWvqKSPz44nBl0mkqPTRw4L+UynsTfsFb9BMcA8aRx2idTbCPkax5vgAmRiTc4ljxEnxSDptvJLagrc4hVdXVIV9e0qIrIpUSi8Qeg5QVoGbIUzBbt61FAykLZNDhyUqRYKjy1Z0w6Zit6gBLzcuYywe4zo2XWevQD+weUrjkgtn4WmH9tPZiN2P2AnmA6bY5PruLZuOu/gLV/1tk+kNG/zUH5x1X7HlWEW95fh9407SginlJnjkA8A3B0W1LCbMXfTrMOwfhG69XofcbYdocq+QNb33k9H1H9PrLslgUK2wraGRnBWrKK+ih6qpk/mwD/vD8/AsHJBspozFptfAQy+l/XdwuwoaHPf/0/kf+nQuuo6FZ9tDC7HN74rs2xaE+TlYDfGgx00psEea/vUt3YzfJk7kmATTilRst/SO+6jT3Y6Wv+XofWJ3TEeuXQfw7F9SDDHtEzGR67QZXeMow1FSa5jaNan+3TU1a1508prFnhyLFR+kvdySm4buNqF5CPSXePeoyGuqMeSVN9Vxv/OiQEUB/jR5nF47fwE7AXlA
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 secure vaults</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/key-managements"}></MethodEndpoint>



Lists the secure vaults that you can configure for OID4VCI and OpenID4VP key storage. The organisation must have a deployed OpenID digital wallet.

This list is the same for every organisation. It tells you which vaults the platform supports, not which vaults the organisation uses. To read the configuration of the organisation, use the read secure vault operation.

The response status code of this operation is `201`, not `200`.


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

Secure vaults 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"}>secureVault</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Secure vaults that the platform 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={"id"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`]"} schema={{"type":"integer","description":"Secure vault ID. `1` for the iGrant.io vault, `2` for the Hashicorp vault, `3` for the QTSP vault, `4` for the database backed vault.","enum":[1,2,3,4],"example":1}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`iGrant.io Secure Vault`, `Hashicorp Secure Vault`, `Qualified Trust Service Provider`, `DB-Backed Secure Vault`]"} schema={{"type":"string","description":"Display name of the secure vault.","enum":["iGrant.io Secure Vault","Hashicorp Secure Vault","Qualified Trust Service Provider","DB-Backed Secure Vault"],"example":"iGrant.io Secure Vault"}}></SchemaItem><SchemaItem collapsible={false} name={"isEnabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows `true` when you can select the vault. The service returns `true` for every listed vault.","example":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  \"secureVault\": [\n    {\n      \"id\": 1,\n      \"name\": \"iGrant.io Secure Vault\",\n      \"isEnabled\": true\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 OpenID digital 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>
      

---

# 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: eJztWltv2zgW/iuE56UtLF9yj3cw2EzS6bjbbYI6bQdoihUtUQ43sqiV5Dhu4P++50JJlOykKbCzL5N5mMYUL+d8537I+06o8iDTaaFN0hl1JkWm5DwXSxnHqhCJKXSkA4lfcxGZTJyPz/Y+nY5FkKlQJYWWsYh1pIJVECuhbmEoF+ZWZWKiMvjHm8CIeE3jPXF5rURO4+JGqTQXBQwEJklUgCcIk6pEyCQUy0wXCjZKlIgyOVd0tJLBtUjUskFV7yq5Sn766SdxsoDNgCAexlE8bZqZJZwofCJhYhZZoHxxcgEMyAT2AXIKkan/LFReiGslQ5U16YRNMwWnK5glQ6bYx7NMpr/RUb5dJyKd5UWX6NeFiADBXExlcCMKw8tkcxkcmq1EKpHBAtabJF6JJTABs2VJjdC5UPO0WPXEG32raKM8uFaASQqE6Ts6j0ZTGSihE/pxK+OF6vJGsIN/kup/qJX4+UatfvEFgOn/qmQG2/9cmBuV/OI3mJZBoFIQ5NQU1/Y0FAZsB3uBkLIm9B9UnoJ+qBJAHPdPTVIA5N7lKlUjUai7ok/q4eWkYn5X+KcgUOXhxMzEIxCrF+AIfaqUYkSq4skYuPerI39D0HLmr6gJZ73BScOe8DNVZKuR2B3Af77wNicyQ1bDWHpTFjYIECgJbljgJpvJROfMtRgXV4kQwBIKmDQ41qjlIOalhIW7AzgFtBq0pd4tU1bPc+BhB4gjMEal9qvQF0sNaON+oSyk8O/X36VZRgWrqMgX08qMiTqYg4jBYbv1Ya7h4OZPsS/SC550bWLgSSbC10BupFUc0lkV4SxaoBdUOwFlTBbzqcrYJIAj5Muuq9e4hwkz/TeAAUTvAdENyQO1cPBk8hoQm88R7lgn5HHAhob7JeIoHTDtLNOAVGLYIzEBLKWc0ZklLBc4ar/GR2WZyb6LOpkoKgh7kEhbA3S1BE2Mv9N5mcpNbK2XXWvlJ9BrAW0mV7mDIcNOisCok6gQOTAOJpOm0O55IYtFzoAAlTJGV7UCBgAlsg/4X2o0ApGbhv4ATrdwLgnj98vLC7EzGHRRJDwkafu9uzt7BJkfG+CFXMVGhsJEINmGDGnr0v82ZM6cPCB0PvHVKxRacqticDOvXnXFIon1DQOHXBFqixR2VbUjyrsgEw3Ku8xkyqLgLcEZ+g2dZ1jtVxkv5SqvqQIHpvTsumBq8xGpOcDtynVMI+6e6N+2jX1QMRAZbi6wjhGHGVX8C8Ipzj4pfOLQZxbxd0+8N8DsJhXMcglMt0QFl8caolkNjwgNyRT84SKzFm11hsXXsnlWIgLHXyS4u8/q+giZoEtKfEwgHhUaPHMh5xDeAf/SLku9+VVdy1sNcbjUkKaZSauZdSxEQ6NT85ai9cRJyUVwLZOZsm4mVGBeyEWamXCBXsjwpo0QFxpyEAhKGssVz3ACivXpc53nKhzBtpUDx63h3KxAKzJzcrOiyGQEhFmY3sm88Cjj8MZnPsJJqcYiTU0GcPXEx5xVuikojCCk5G0TceiyiZl1xWzpPfEZkZIl0XWmYh1yYYzIY7OMV13XtYWZSfOSc4wAdEq5icTUB4cSMY1NcKOTGdsWjVtvaj2K4pBQOX5wfUSimMmUZX/ZSB1EIW/YQUc6xhhWZUHN7Iv9dO5aSqznulQ/E0WQv/lVapICzY+Baw9rQNvrdDvVpHEIOTDIOdKzd7D6TM90IePPhPk5JKfj8L2zdpIrWFyT3hl9uW/l0+f0h4x7aBsAjtCUNYOHydD2SBjAytTcNcMHELvIlRUKcGZTVCvplVmgdw/5G2ddtWQ1CCBbJDZ1qfi3mWGA7ueuKE9PgPZwKw1V9ghKPZM6yRsKSMvh81bqUTio8e66OfzZWNxOq94paSOkzXzNoihxaG3Qc50HsWs1vkLDcSAIlqyLA2VDG+RmlABjrpvDWkyDHXi3rEioboAMugk1q/KDkiQfgV/tYo77Vq8dikHvDYrNnuPh1AC4RbnJBwQ0LVMPnGyrjK1EEAP+xcdL0b/d6bOC92U410lfphBfV/17SRXCOFz37Q4e7AC+C+QH9BHi/h/eZDFlEUAIQr9G6aqCSgRxCkmbWLouXw5YqH06WSDrxpYZ4OGBE5A1bs9Hn2ezMSXEoMQ6qtWd6pGySqt0YBvD8wWonbrTmNLT31PIKNCBGdwt21RXOwmZic0KffRJAsnHTWKWiWO06OBbNrxdOFXphXZQbmoz4cYONI+pY1BEqKMIik7wwU0qQRfm0uZCpBmR1LGTu+0NBujMNPodBgl+oUTgdxNaGEeHoqGG74ygUM1Vt0NlnuyM7jsFZC+wBGIHuPzOuttRdxDNYxw7ODo6VkO5F+xPdyKsq4ZyNzwcDmBW2/M1amSuR5lWDYGzUcF2ufrgQ55UqrKHJ4dfFs+2bq4Cd1XeWwvZXrM3jy4eaxg04lIdYd3an5PTvLTr7ZW92ijsS5lRP6AWWaNb8CMScwVmoVOrt9fTN4E+128nH7+Nh+/1OB8nH/aD0/HB+Cb949Pp2+MeTPoWfh7jpGGw82k1Tga9HDwVRN5Mddbrr0gDV/o5ngq1Av7TFLsDEnZzFKO/2Qxq1DnltphXrXJuAy3AQOKGROsayW0ZZW5G486BxCVRMaIbcMZNSLX7EDj4MJCt5tjDXIwLp7rx66K+lfvbvMXWmRx7uWnWrfo4ddHbKHVtYtQoqMj7tA6g7cr8ULydnL9vFFh4Atc3uNpvpTPElU/uaOkg908VannJ2Mg0je2C/r9z0kw7a9KGkc+FCYUuSBu3nbaBslNZFk9mGImFfB+SnUKzdupwm0DB3OcSNKGzWOhw4+gHc7RG3dEwsINwIIfRrvJ2poeBtxccSe84Gg69XTndDw7CQ3UUHaMPbZZvP07aeIOmzWgDoWqzvO6Jc/Q+TjUwo5qf2wCI6t+eWEQCvNgxabA/iI6n4CxCb1ftSW9/ehB4h+GRAgwAlulOsBvuKWS/XR1/39hwVslq2XRuFKmV3FWyADP+0qlb0v8CBxLyps6gDG5U2BzK1K3ZGFR3KfnZry6jG/tsYaoq+f8X4sWWEQafuvTbKNGnkCFvRjCnM18rclNq08NwGO3JHe8oAM3dk8dDENj+jjcId4MDdQiS29tvM3haO9FH7XWzeWiTflY7SH5klkHBDdPZP9jilspF9p4VA7YzYn+dUtq6sPpoXSnU5xA2fUixCsiGrJPkbAP73skijv069DaqZ6g+U6adasBEnUdUwVnJEZkYmws1z7d5NRmGmqu7C8fzFNlCrTEd+oHpXwFrrnC/bxcfsEFQd282IT/Z7OeUnS5ZdgVodd3bsTW89Q92NsurnOQaGg7AT/7SNBM7tiaD4taQwxL3g7e5XadtJF7UbaOXtegaDC2BE3tAQ7OHh3uHg+HwYDAACqrm1J9FQSzBQ85NiBb2IB1rN3P70iHbbwWDLe7xMeey3S4rDXKhd0H42sjk3bsRrKTa1xFXCcbdkbhf41cdjsTe4XBYzXMpqKZeAXdXndHVk4LiVad71QKC1j4lotDaNkC0uu2mt86soKQlT3GGG9tY1K/QYbinwgD8vg0K2vr1nOo+9asMZ0DfGjZhf8XTMP/jedZ9nztwXFHGfWWlStPYuIiWSsRXrrLBh0rejQ8kRPc+xRHqzhOFikIBmUTevjyYglAPQ+9IHUdeLZb96E8Xqg3YTxDrfnQgD6dHgXccDkCs0VCCNu6CNob76iA6lEfT4+ARsWLg+AH093ceQB8/rB0Do9TfAZd/4/6/QfzCcslUt0UcrVAutoNAxQDGe9NUlKsElAXM27ZG0N817lYfLdOsu8dKGQNmeQmL/uwpFWa5oIME1Ne2P3Cke7/7xEPrJcg4HLw3GOIKp9LbqFMahZ7rkkkEpyZEr0t/nzl0Q3RrB/JmnVGvrinWQMWMwkxF8h6FpI3tHy/eIdLrJF0UdSuB2F1v5MoPP0ooq8rvPT7A6xtqr1FPolvW1ZxJYeIASli2ZhpdGd92cVB0tf4hjfvcH/gLy6R912RvgNx+B2ZccEYbPUwIVbDIdLGinJSRhz+/YmrJ0KPAaQTxkDO8fujYGwvBVxbiBV1aYPH0Eg74HdJeIBemA93XBu86ZorQk7hTx+kNh7yPxy6ojx0ZHfYbFyf9nK4/mMdtdx9nam4sBJiIZDH2JYsizUf9fgjfPJnqnp5lEso4bba0EC/oAo8v3LZv870dJoAL3ls9sDznz21CvtbgT/jxC+pEKYK6QOCBBzquJ632Xas7Wl4GNF4tudVL2f7YbtZlu5ptT9n3FLWBvkjw0hg3KDKIK4QBvg962RWqN+u1th2JsumKzXGEw6Puaw8TeVfZ7jt8a/JbWcy+/Xy5yZtzowJWgheoTJ71GPbdEuTYzR5xhSB3h7FOpQWdytxRbhRndBKZ0rfIgHwLOBGNsrU29vdanpVI9Jt6qKkIrg61uKkW4X3yLVTU2FYLDLoDQFjjvxiW7VMG268gq6NI/UllYDJyCtndaZXG5GIMaaDEm9IXtrfxkjz19oUX4C+qIyqTvniJFBUmMFz2QrmLWqUSXJPbFOFbeX9sBGWeXap9udl4iyeshDV1p2+Qi0VOGlPANJmFuUf8aonZR2yW9sFI6c2Q2s+7p+LTqXgB+gAqNn59+ZuYnHnwC0b5tPHkXAyPBsNdb1/Mz0zQn5+9c3sV3B+h61iIEQq8I0q1NKYUUwyx0xtsiG65XPYkfe4By327Nu+/G5++fj957eGadd2CrMWJYIUmWFTSg63Rk7HYdwY7e73d3hDXpiYv5jJx6OFnkq07+heTyeuXbWtw4t/z48rnx5XPjyufH1c+P658flz5/Ljy+XHl8+PK58eVf4HHlbZ2oyQFtAGK5bXN4e9t4+FL53aHnxFEmi68Gs0Hfp+Z6PbFB950YAsCqvVrSNBxm/v7qczVxyxer3GYH9RQYwJsG6qi+u3Mgzn687OlH3i2tFW0N9gk2Xi9REjCOHVXbmVGlS33s8rWyY8J6vll7fPL2ueXtc8va/+PL2sfcXcb72trf9e9t3NOSCjOt83HiGu3N//mNfZWpW281k3nG2o62z/cByvJytm83X9mGvD/zuOU5pKf0ZBAVX+ppvOXBxdUHVuejYB8Xa/X/wXxfFz8
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

The browser `EventSource` API cannot set request headers. The server therefore reads the `Authorization` header first, and it falls back to the `authorization` query parameter only when that header is empty. Give the scheme prefix and the space in the value, that is `ApiKey <key>` or `Bearer <token>`. The server accepts both schemes on this operation.

### Response headers

`Content-Type: text/event-stream`, `Cache-Control: no-cache`, `Connection: keep-alive`.

### Frames that the server writes

1. `retry: 30000` - the server writes this frame first, before it checks the organisation. 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
   with the stream sequence number, and a `data` field with the notification object.
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 it cannot find the organisation or cannot
   resolve the 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.

### Behaviour

The server writes a frame only when it creates a notification. A status change and a deletion produce no frame. The server does not replay frames that the client missed: a reconnection starts from live traffic, and `Last-Event-ID` is not supported. Use the list operation to read the notifications that the wallet holds already. When a client reads the stream too slowly, the server drops frames for that client rather than blocking the other clients, so the `id` sequence can hold gaps.

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":"Authorization value with its scheme prefix, for example `ApiKey <key>` or `Bearer <token>`. Use this parameter when the client cannot send the `Authorization` header, for example the browser `EventSource` API. The server reads the header first and uses this parameter only when the header is empty.","in":"query","name":"authorization","required":false,"schema":{"type":"string","example":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0.signature"}}}></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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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><li className={"schemaItem"}><summary style={{}}><strong>Connection</strong><span style={{"opacity":"0.6"}}> string</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The server always sends `keep-alive`.

</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 and the `authorization` query parameter are both empty, or the value has no `ApiKey ` or `Bearer ` prefix.

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

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} 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 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: eJztWltz3LYV/iuYfak8o73pYtmaTKaK5KTbupYmkuN2HE2JJcEVIi7BEKCkjWb/e78DgNflypbb9KHxi70EcA7O/QY9DiKhw1xmRqp0cDx4K7XRzNwIds+TRBiWKiNjGXLa1yxWOTufnR38dDpjYS4ikRrJE5bIWISrMBFM3GFJj9g/VcFCnrJYJkbkFmEb03zFcsEjpg03hd6l7+YBZlaZYDyNaIMzLXge3jCgWo5+Tn9Or4AvcIuBXWVLbsIb4UhvUGbR7AR3oQle7NrNhGvDPuyfdk+53eWZClkQqfAKS4Fbi6TOEg76+BIXqLh7R6jSWC6K3BK+a4mmE1LrAqwTVEWzFvmdDMFYcs9XmmmVe2lvCCcosogbEZ0YUJGKewGqY5lrM2KOeYCe55HIA5bxHHeQmG+4BiYmYqjDMJLijQTFmXC0jQa7g+pjFkHdjnRS+plcSMOTD1br55nA/rsGTYCsrtGD44+PHbt5VyznIADCyUWo8ghcKaZvZWZNJuMLmToS2Am4WeD3nWDYKVKyAj6H6dzxpBAsBgEQAA9vCUMwCYhoSVf8Cmmu8EECxaeKYy0MvnPxayGhjcExYLXYHWgYwpIPjh8HpFcclakRC5HjbCRiXiRmcDzZHSxlKpfFEr/X693HEm0il9J0r2zz+nf+QIAs7eM5F6bIUwYpE9di9KUETh1V7Zu/d97U70mVNL1PbROc2x30kKFNLtMFdkRKcvk4IGz4dGgH18+g6NNBwjrdNhqb+MgTP4va+q5/wX4jt9lYhE2JqL2Uizu1sSgeMquuPn4v60BE2vbhLRcaSiPGt8ncgn2WLXi2+u6Gy0PL8HnrVBQ2nLWJqLLAHa5DxzvZA8G7rxdbraGMI88hrpY53YBP3Dq4blivW+/h4dz+4MmIvU8lSGHSSj2WzpGIJ40AOlcPoH/BU6l9OlCs0MLzjZhGpAoKhh9uRMpWyDZa2LiLvRsYq8hd7C4Dbl6kLtBW8Y/J1AVyBed7MOXtJJaolwZCyA3COkL8gssUAbmRJy04tnupp5QAk27BLfGzBSxaMCP2VnDESFp3DDFVmFIOHQQb+YX8VTelgWSQrNh9KSxeAAPkDg8DB9LcIMfOYaM4yMNQaApltyJtiLcHImUnFzN2K1ZtURt+6/NwryziXC3trge2wpGLVOWiRTHynCK1+XuGdDQEt6Q3vkVBc+lzLx2GqLYSYRkILt5fsfHd3thlwTGPkBLGPJOAHj/i/7+J1Sxajz2GITAEjPQH+qzEg38ML4u5U8Eswp5jOxIZ3JGSt7Ump90mXw1hkfXJtBA2d5DoM1iYASfQNaF3V5/nC8J/j8uZjGtznyuw4dDq2gb6GF4WMDvxgES/637PRaIQJHArsOWb5uoPETOJWokIiTtFfrlN1X3acFoqdzo+3K+c0nmsH5RIXbHUxmDPOeqcUFB/oZ7JKWW0qYQtLGFrzovpK+Yycar9y9XVBTuYTKqo54RUh722aJ8VmBH8HvgyS2jt5atXr8WUH4SH8714fzKZTPl+dDSdDNbXhFJnSIdCE5K9yYT+a0fDqzp+uEjeUwwSCzZGpYYQ8CxL/Nb4F01YHjdJVfNfUABSzZZTvDPS0dDE2zjN85xvVjnvWildpT7f2LALy7bFjTVlC06aFcvM+BjTCIw3KolsVbrBlTRiqfuobhNy0teK2EwAw/l0nTHaEIOM+jJa+9Kt2alJBKFu2EI04dN4Xwz35kfh8CB8xYev4+l0uM/nh+HL6Ei8il+T9WzUNp8khk6V95cMt4ThGGXBZgUUsB0kZZFjwzYkPEXQQQSFRBawT42mKOiWSICxWQeKs/mAfD4R0UJEnc6nA+yLKQ/u2x+/+DSkr7g8ZEOXfsNWL79bmddU4gaeHoX9KBIK7rPPMKPZhv1A6Ii3lCYpznUtityIz5Hod62Be7q6DWdtlW0LnB9F0/iA7w1fhTDDA/56Cgs83BtOov3wpTji0/nBYZeh0zq0tEm/4KtEUVvRY/esEbgW6OQ0uaKLAzju/Fg7DsmKLIKGvoOW9k+b7bMObEoInPUEyBQGQV27G12HCBEFaZEkwfZQkznabb+bivPYNqytaEeVaTfs8CiSrjq9aMQLkxdifQ2p+b7pkzr/sW7B+oVHHfB9W+3UuNtixYEFruMKHNtuEtCoXNH3to5To2zP+3zaxh3ylHLuQtVddYl+e6vXNCu/trbe42YSDSm4LrgvgD4wI5fIFsDDdiSRjTwW6Re13lp03kMG/oKWWU+PDo4m0+nLyQQUVFOR34sCOx5aqojcaysd62a98JESSk9Yfypw9Pvgbt2b15Ju8kwd6aAepth6IEna9l2Zs5HGqu+iPt/NhGGRU12FE2LLNKIp0FN32qZ+Vgm9lg9oM8rwZNbJ69vwXdHhxhTF1gOM38HhaSDUxL13WCInWr8EORFNcyWNXARVl2Oe6oZ9XOAWP437XYfkctjTkgZZK9z6ArlHqlbcmCuVCJ5uJgskM2obbI0P48zFnyAOpGqHYeMKW6i6W96hg/3yG1Lqf7vYbdxbr6+7OEgBZVjenEN0iryup6TdkWJlmjBtYsX1MmCFvg5czfzZ1W/zJpQ8Kj9VkeWJfp81uABTT1fKNXSfNVQyOrAxaQN937ykiqbfITvINCtMPbeFmCz3m81Bq+FB4vMN2C7zcveJz4f4ROrNksKW2l25Tv/Acn2f0ixD5fI3WxG2RXP4hza5Ge7LUf/Y8QSCmr2mIyOqhAQShzQrm3ZO7JwEP6+ppvrODpFOIGC7QlzzBT0YDPwDA3MvDGzHvjFQL/MCF/zF9hokJFB3o+hpYmGH+xknTIPGlCZyeIbO9McQYSqjccviKZFaBvpeKs7EUnn+KLfmCU0HjMn08XgcYW/IMzmSi5yjo5JqsDnCRHEYFaEvxHrRfArDpaG4t9gGrt12l5DrWvCXZH/ObErx1/WtW9gy9zjxpl9G4E6rXY7k6mFfVe674tsXtEELT1AOGcuhEVJWLB+QDtyczdHI0N5BTa6bMTnyh5VBxkOBdlCMFqMO2mPmAb+hERWJg4aA36JshQ02De1x4GaX36t8yWn6/NcPV5u8Neaa8AOtS/IcJk8z9cYtIlglQev0NrtagEHl0KQ3m+lkGqsyevDQRg+ECUm61UWWqdz8udZnpRL5Q73UNoSmDXW4qYCok79DQ0h5PFTk8JCwpP+X0KBjoRwdWI+zOfsnkcNd7LPbadWIaTYrJwQ7fszwwjYU/YCobHR1ReXOFy+IIqNC5bo2JC2yKpESjPYJ7Tc/VUIvYhu9Xdu6ue7ljm5YMe/mjbYX2U9bizE4xvNIDy2/EnJgcaLutVOnl7Sllp55fzplO7AHmNjszdX37PJsiC+suttml+ds+moy3R8e2rff8fLsbbPVjq1J2RyKLCBSbcNz6UywXch1bzTZUN39/f2I2+0RWB57WD1+Ozt98+7yzZBg1nWNXquThBWpsKi0B9QUyZza9yZ7B6P90ZRgM6XNkqcNeugdl3VKrKidJKrE9vWl///9pd9HJ3rcGoMrpIO1t9JHn1Y/Du723HQZXJGttFKr+2OBdKO51ZSmb2B8hODxkVqq93myXtOye1y0SRdVKzy+nqdvNcTf908HeqVwSxmz/gsCC44Fl6o/m/Dn/h3AE6SU7egXUvLsvwt4gpRqBPFfpuUZfxHwBHU9U5YvpPMzXvKfklL5oP+lt/+nb/lP0dZ40q/Ju6aP3KZuV6yXteHzvPXrA/7XB/yvD/hfH/D/hw/4T4S6jWf8Vjh2Z06sUhp7GxOddXPu8MMb6h25byzrpvrWNtX+R/M9KV01cHf7a0cC/dt4cWqDfEN+BEv9tjrudrYCVB2pO03yoOnpvwGrzHED
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWm1v47gR/iuEvjQBHNtJdq/b4HBoLtm9uk13AyS7KbANYFqibV4kUkdSSXyB/3tnhtSr5SSbvbYH3H5JLIkczvs8M9JDlAgbG5k7qVV0FJ1J6yxzS8G0WXAlLccH7I6nqXCsUJKeckdLwt3c6FuZCMMyrvhC2CF7pw0TPF62iAxojxE218oKtpC3wp9kHXeFZXpOV2diwVN2LoyFcyeJUE7OZezZOOWOs52z88npLouNoIc8HfRQufKsfQSG2bFzAp8ihZ2rj8e7A8ZVwgoLzLJYF8oBy5ddkbPCOrbkt6JX1JjnfCZT6VZMKD5LRTL8t0IaVphbGaOcecpjkJArNtXzuRVu6jUnLUuFJTUqNiZWOJumMpONFWNgxi+7k25JLCRizovUsVueFmLIJvOaLpLkZgF8EVFcrYpsBtegDtA4bLNBSxV7rjDK6z/lIGkOyhhGg0jnwpACJgm4Q6zVXC7QKU7lQjqeer1+yAU8/9BQl7+P6gYaOTc8Ew5MGB19fuh42DuZwhM2W73A0sHI3lqlKLHO4MDgS6QcJu557NLVgFmN+i/UjdJ3KjzMuIuXsFzplsFReIkM/lIIs4ILBTLAZZrL5IKOhXtG/FJIYCc6mvPUikFkgVTGo6OHyK1yXG6dkWoBSwVYAMQHmsAL+Drcqn6I+5yoIMFbfQO/rtfrwXZNPerNLJVzEa/iVPw/1HNX8K/RTqF44ZbaSEvqaF+8VF2tOEY+tzHfXPgeb32BDD0cvG/EXKxNAjrXzN7InM0hmiHCwBdIl+yYKXB+FA/jvFBG8ASzSLABHJ1aNuPxDVKYjqdbBaAE8Cy2pXICMgSsDYkkOhoPokwqmaEpxiRP6fOYjLpHtmX9J7/Hja08U8nsswuDVFLllRcxuD/u0fIH+sHTIcYDMMdkSB2eDcpykFRn+r7tCMBXAXUHTeGWkDGRI4ikIbtaCsVWuoCQgVxMz5ZgD2E6KbMI+bJKkUz6XAtZ0ol7V56OSkx6eRiU+R0q0IJLZVt1lLbD417usUwo7Vr7MvjZ2twuYUPIsGX98gIxXbhSDx0CUL66BYyjMWttMK3SFbsrlYWhinqHhC18keJsJiDTGMbjmAochKpqqLdnh2LH5xN2I1ZtVTt+U2KDPl3Mjc7oadhMypELpX2aqziGRKjRbOGcPVwag7RoN77FQDNJPiCILqhqKxMkwPT84yUb3R6MfKEc8QQCasRzCbtHD/D/H2I1SdajQGEPKEC1BvsBf6Tx6b/2LoqZN8EkoUrua30O4QR6SsibvHWbcrUSPOhUFYIiD1Wfg4c5kARsjeT90VCskf4dHM7kvHb3mQYxPFlb+0CfwASIxD1ggYH/PROpVgs8FaiZTXcNi1CYVK8AIbHjutjUQYtorBPD/capwBHGQUnUY7k2BVrnufNKYYmcz4WBBR0uwRcy8DUfxXg15zL1pv3b5eU5ezUeV6nXK6nOvW3VflHpwJLGszzFe9+9efMXsc9fxa9nB/PD8Xi8zw+TP++Po/U1kvRo2SKRg/EY/7Wz4WUPOPXpVySP43gUjDKXckiW53ka0NfoZ4u0HzYF0LOfRUwQz2AWdNJzpvuRYL2PG8M3a8gG5m61GTok18KQ4aiQkOOn4ILoBiLLAX6DM3egSpMM5EsjRANFzwklkPDSicz2CeekI9NsBbhtMa4ax9kiy7hZUZXZb3NVqIR8c8Ne7XDm6R1fWQpOEPFWIDEp0qTKAZ7N4aNGIDDTA7s6eKVKLZ3CgR7awL1PErr4yg7Oa8BjH0ktk7etP87XHOpUtL4pcgpSsmCJIilEnwWzm5EX1gVZ3+Li1RY80hQWfOCeOZkhCs9ytgPFxAL0AXPt1pyihM3GxbNiO4ICsqu3tJxlyQmBd8iQYWrE/aRdzjqdwbO64yGbNlH5lGWCB+TTDKyQh+uFsO9Zu+pFVKKCpNtYWgE0+XrveGmb0e8uYIHf1lu2Cf9Cr9lCjrxHWluI5KRyKdsrA6Qv6AP9re9ebSZu7cCna+hfe2hjOtTizB9LHEBKq/LBb3J6i+CW8yFPItXAAk48jtGc0q2ejqJLWadJmpWgMFzF1Ls1D2c80OxH48/z4hp/YzuFAFBXdIfYdTZwxue+DrY1sGhktkGrV699uM8nulbqqAzb76juZzdRyTmO1hLhMBRDxyXCIAoEpOK1reie12S7FS5AAST+jMg7aQCH4C1RI573QQSHnjTpwIBt9LpuR/CB8VuQEVv3Ju2D1yVx5PUlxJFpnABglgTHKhvy6oRD9GK6+TTt9x2Wy7a8pY0xEIT0cQ6pT+pWbZlpnUIu3yA7UQm1ctRPgH2N+BOoA1CNp7BxBIFif8p76JZffoLCXrtL3ZlCrNePhUdnRFl52TXtCi0QcIVXrzzUfjY8bp4pjNHmRCfEHv4+bQh1ven4bR+vd/cZthIXGFz3kO+btFUF7EcOXbLKC1ReGNBGa6+zJ3B5Wes3kGu0qbj9P7DiPpYw41eCEW3VvP5D+9QEzjMKR/hQ3yAB0TEdHcEmwEaFoar8+SE6pvkJ/LzGKeCPNFw6BgXTHZSaL/ANQxTeTZS4Z4deT5y++nSyCweEm+fBZVFbwOZS4+uNhfC5AElGjTFO4gnueXcfgS6VTEb+aq90/lEzRMLSPWpdI5QDpex7/3EqMh2UgMDUpDhacC63R6NRAs/2eC6HcmG4ckOpo835J0iSFDHF5RYyT1EAELBAzLFlu/WPu4xc19a5QCf1vlXaqG71/Y0tQ5PjEB9lgW8zVs3z6klhBzkFYDVt0ZmWE8py4gQ1aC7voXT6IZ3nkU3ZDmQxP+xxBso26SDnsdgdMDFcDDtkj1jY+D3Ot1AdOEH8YUoQsumND5EffL4rcevfry43ZWsMRSFYrC3Z85QCzziabDHBKg1SZqBySRtqCIV2I2Ao1VyXKQYgI4V+BnJi6BZ5ro37a23PyiTyp/pW2xGaPtSRptpU1gIszPiqCYIA8C3+z8CCXoRgNB+WBAc/EbqkNx4N2MkmJbDe+UDxO9ml6V7/RoAqtjqiivnzXeTI6Vin1DdB6UKv8i9pbShrv5a9gvaNyYAtdRpGiQR8VyykgFZrU1jyGAfLuEnsHskrQQ9snuq7MGQKmiZurw5P2KcTtgP+AC42eXv5jl2c7sEV3PWnTS4+sP034/3DvdcsO9XxKDs9a84NfCtE7SyUCqEs5fAymMB3Qa8Hw/GG6e7u7oacHg9B5FHYa0dnk5O37y/e7uGedQ26a3OishIdF5X1fC9gvdkPxgevhofDfdyba+syrhr84Hvi7QO9bkQ0SuG3zw7+6J8dhFSGr9FGIAHUjnVw6YdQnz9Htwd+Yg0VGn2pVaP9lwtQpbG1bddpfLS1UkNRW4IfI/mHB2y3Ppp0vcbb/rUn1W/Yiaqu5vpb3fj3/G1Dr4ZvsHS3JwZECG563PAC0X8nHys8Im9zDvLV4vZ+bPDI4T0Tmxfy8N/93OAxEcqvDl7I+Jd+O/CY64bBSM3JNV4Yggi+cygx6JeF8revDL59ZfDtK4NvXxn8D78yeCTNbXxr0Mq8fs0xGaXxbGO8tG7OPn56exnehLWb9xtq3sMPzJnlI7Vq0O728Z4F/IsM9W75HuMIPPWHarl/snVD1fn61agPnNX+B2Tczi0=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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/iuEP7WA35N2e0FRXDbJ7vqutwk2SXtAN4BpibbZyKSWpOx4A//3nRlStiTLToPeHgrUXxJZIuf1mRm+zGMjFjYyMnVSq8ZJ4zfBY8vcVLBUmLE2M64iwazjTlonI8v0mHG24EkiHEuNnstYmDa7mZYGTeRcEJHLwfnxh7MBk9ZmRMlpxxPb9B9TofD7FZsLI8cy4ihEachMKzdNlpv5U+CgzbLJuIppRKQz5UgsqWIJ4mQ8oY/aTLiS1tMMAmdKOhukFWYugWDEo6nwGhcUQAJGjI2w4eMMyNOgEY/uJwaYxp5Oic0ss45NeVC+YiVglfKRTKRbMqH4KBFx+3f1uypLo4Cvy4wqSjM2GviDliQsW0xlIuD3kxI2mdX0as6TTFiiPhLgv7FYsJlUmYOXOonbjWZDg79JiUEMMIi0GsvJe+B/LicS/PGRdCGPxVcbZFyvhQQSKTd8JpwwtnHy6bECrEt64Emb3Sr5Rwbyx0I58DoYBpxH9gerj/RD2aROs8wKBgxhjLSgM0y2rs0+ToViS52B7QgK8G0K4BXGIye3qMmU9+5awdxOoKMTDy7nrkD2uFYGJMgdYBBQN+FSgY8L7qXp8LlWesSR0q40bwaPpcllELXZe5EjyCvEdOZyO1QIbAHIhPhdW4NpBfGzyI3FM6AAdodYAw2kmwIaRoIbGMijSFiYq++FKpi3ZoZip1cDdi+WZVM7fp9HUp0tCMX4NUwm48iJ0kaUJIa40ui2wKeFQyPQFv3GdzhoJEM6wMFO7xaCFBhe3d6wzrzf8TDv8BiCocNTCbM7j/D/32I5iFedQKEFFIYM/QfykcWH/21dZyPvgkEM37zasUiNQDvFhCbv3aJexUgH9EEEouqaTJ8CwhxoAr5G8p71pZkg/QUwZ3K8gftIgxqerN1goE5hSkniAYK06Z9HItFqglyBmtmGaxiEyiR6CTmKnSpInPdKL1QhaDEDV2K43jl58FAc5ER9/i5ToHFeOm8UFsvxWBgYUJESsDADrPkoxl9jLhPv2l9ubq7YcbeLKU1i3vFGgl/oEfhdNi28x4QijYCsN4ayI5oNCzl2xhsnjw23THGKdUaqSWPVbIgHPksTfPf6zZt/iB4/jl6N+uOjbrfb40fxD71uY3WHJG2qlRUWifS7XfxH2UY5fORpmoRi1/lsMTs+bjPVo88icphVDWYuJz21tDb3nlSz7c3eAl5TnNBe+zlrGR/PI5I/SS7HlOKrM8pCDPKijb6uKfHtLR70/gycgaDgyQ2QtwWbSDDhhJy5dkTvVZXrr9ls5PEYrQkxJAD8wIXEAiUT8YbRU0xe72YiiVSBV4HNh4LOT7D4YTeHouWQ+KqI2U/1NtupZ61kdwjaSrmuX7iRK/eu2+pKWgCbhTQSU6DXwC+32UbYHD6/+CXfc5D3n7BsLCBA7gRjWFK22QWsrhikoiRmU1gVobKMG8OXPrVoheU10ibG0PJL0yZTYgHLEZhmYFGyBegoM5i/SJ4CAIjqltTn3PGw0IG85md6Nr50eFm8aBthKNM5MbN1yeN5AUnMkbJnuqXNrKJGSIzFvPiZq4ybZavf7b+ud0sOkBi0beZrMUpUUPjeEosW5up3rbdLWJi8G9Zh43+cGXIxgt5/Q5oo5Ic8ZdTz/BtyRpVTJYF4r+4w8XMTCdBOuHVH5Gr75ZAXGHsBGUiAHXlx7QHeB3h/c/B+/dXwfn2A9wHe3yq8e/2vxnevfwD4AeDfIsCjbJYl8GIuDnvZ72MvexM2pnM85MSzI5+YSsdxsRb+hCriSYT4EP7ozsMBnBzzJR2nC6Cy9LcOeKg17A631Sjt+soL4vL6oZJuS+CsUWTftjbsYr9i+725P/GH/bdKuueEyNn6JqZ424K/MWffA/kdQfIEYPvd3Xgq3eugEjzKI3sPxd7xl1HMD8jnPJEx81bB6wvHTp0TdKamFbE1Yq7v0fn7+O6JvDB/zz3VLByuA+boNscfpw/JgEO6zAEweu1rEOntvDbPRuAalG38iEgp3KqVTLMfS0X4HdB0QNOetPQFeKqwDyfRTx4Y7khpO9F5V2VUf9gOw1ZbJaZ0BYf3tyLec4uO0A23N+BkJHf8zFuCopjCGG3OdIyeoOfzgmx3T53rb2bvhRsIuKohv3e1/SPHZWSagTPzq2Fw5g7zlaARrou2Ow1qDNf7jg13q/B6Vhv5p4i3TPPqu8bUAPgZBWUL4xJSC7Gp2AgmWQGrNemWVJJO6eoXHu9WzcfGj3QvfprhpvITpTbHJ9jb0AhNEXkSf5HfiJy9BAbh5VWALFoLxJxq7KuYCDIWR5KNwg107Am2PNw7YEsl447/1crB37HFbguvVl2rxbmY6aA1jMtMgtegzqX2pNOJ4VuLp7ItJ4Yr15a6gaqWCYDocRZRIO4g8xQFSJcT8Nyu6dZ/rgpyt3HHNaLSgyl3yuYswr/YccF7GgKCUL61rFj3Hmy6Gqjn4ibvkskr1bBEZ5h3U+S346kRY/mANZYaCryMbMheQNryF9POcJmQDVIeiZdNJtqTdoXsCQsT3+JdPJoDux3CmUIRfo8N36TxEx1EgB7/+nizrVuhgQOiw9pcPE8pyIzb7ZIQbG1BSgVoQ89scyWMfqMyLNVY5zkFqj/F+gz0xFjN0lQb98+NP9cukT9vXpWBUMRQRZv1pDz5WygHkcY0ABaW+H8GHvQqBKf5OKRzIr8rxC4rVtgzsvU+/kW44XxZuNKsTrwywq5ZrIP86iVK5HSkE1pVQa1CVPmWLhvq2J/hbMNpv6tu0r1dc3N8sGQh5ktnL5klxDgYxk1sW6SvBDuwcaIXYQkZLE3Sfjw6Yx/O2AvAA0BscHHzE7s+b8EveOu5Da4vWe9Nt3fUesVm5zrqzM7fF3eQ/myLliRQG4SylLTzYEqp46zf7m65brFYtDl9boPKnTDXdt4Pzi5+vb5o4Rw8PJAuKWGAjBVr2OnmpgXSmMm82/vd/nH7qN3Duam2DpZOBXmuvrwpsRoehUJ46HL8XrscQz7Dvr9OmnAoIKuA68dQlT815n08iKG6jBgqVeYGNUpCbYaHSnXG/FnYJMBCA9CL9B4fR9yKW5OsVvj6j0wYWmIA6rmhROMXHHklo4IOtkbTrZuSdkL50Fd56Ks89FUe+ir/j32VtUn0Hpfo292VlJPhA+0R/JhTckrh29audFXcMv18gStdnpUbqAhT+N4/FM4TuVoWaFd3A14E/IsC1U55i3EESH23Hu6/7JywXj/70WgPPCP6C+zchtY=
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.

## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><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: eJztWm1v20YS/isLfopxsiQ7KXBnFEUdK03V+hK3duICqRGuyZW0MclldpeSVcP//WZm+U7Ktgz0ENwpHxy+7cwz77PaufNCYQItUytV4h15p9JYw+xCsFQLIxLL8QULxUwmki6tiNOIW2GYmrkP4W6mdMxMsBAxZ1qkykir9HrIPhjBeLmEcUfaWK6tTOYsVTKxDBbDR4lYbeI5/DP5M7nAhUIvhQYONtMJAEgEg8/1mkgIHixKVgO2knZB3ICwMJbBQoNkVRIBMKQWgaxsoaLQoZqc/HbKvmYCyFUy8iRkPDKKwWfAuXphF9zSMqArZxLeJYpFKpnDFQ8CkVozZL8LHjI/FpaH3PKhNJPga/QbsvCZVUAtipBGzHgKGsnFlAaECp1qeLTia0RhVgDfyfTzxcUZOxyPh+xyIRKnUKeXgCeJsqAe4EqP2wYZMGlL7fGEgTR2zfxSKp9xrfmapAZx/JTPZULW8Jm6/iICW5qi551ziDp8uEZAuc2TkOuQVesKkmxamMFXs5kR1h8wP5KxpAurLI+mANHg3YKbMy2WUmUIFmDik3fi1vqE7CGFAzqOjhKD4ZzXgAmMEGy1kDXPMWytMlQly4wYsvfgLnUXJhP4DcKAGEn5VmfCZ3O5RL+puxN6J+rAD1toNvu7N/BUKjS9mYYQmIFKZnKO4TmRcwkqueRRJOz7VMD7sxqdSUnmopAIiIF/cVALOJF39OmuFfTvsvga3AcgaREojfEAmrmRKSGvDDZkxxBNc7heCgZvsgRdjV9HEAU8ygSbASbDrnlwQwoZ+0NgLZEFKQJuEkABt87OcK/F10xqARLCWiMGnvNZ7+jOs+sUPwU/EhBU8C0oiGeR9Y7GAy8GGeMshuv7+8FdQZacps2yKeu/+S0uZEmfzC40GCgepRbD5wI8AFRXuNakKjFgAPgaIhb/AztaMBVe8jSNZECaHX0xiO6uS93FCFpQo0NY6aiV3oo3TQnPHk3chT8GmdbwpZOVUqILfwxhygyrbRMM2RtjtU+C7WCymVbxowWmpyr05fxZszpQrniDTwIwLaCQPCpSg8tEnPmOm8syvEoqZSZkrxWkAq4hrpMsivyatto4GSQpTKgzCaHitM9tzrAqbuDDQAr++pR+rgWTjh4VKruCgiFjYQbwJuCQnDbxIgGwNloN2Q1k31jZ6h+1CtwzilfHSV1Ulo5grIai33GEKRmASmjeUZQuIDfoE91M3HL4CumeQkqKzsDUmCodLRdVE8Dt3Q+83A0eh3IObGB9UHecOqCn+lvZHLTN0gR+MBwPxwgwDP5hwv0vK/t42FyU4ZEH8fTNxU/sfLL/y+UF+3jSdehhxyybcwwPQwpCUGdtBda1NoyTik29xkHm6AKgLhAaj7z761TBBzo/F1MbnBCYuZrrzOJKED58RjhKU6oL7FHw6ybXSXEHFbD4quO2D+gClPxwYpfhfyFiLueXt1//svqdUm//dfj7H8vb84vLJUpeIb4gCI9BqfkBflh4Pshea/pvSLkdP1gG9jMZDTs7eoIkikesbJpUUD33C4mDlgNumRKelpp+ziAf7JdNDi7q4Y80etgzx581ATBEwF6cnk0newgkzTTYaHss+br+DBVys7hW2G2bhVqZwiC3tvCP0jhYWsjla5FVw3KtVCR40gGT97pliJXFstgCNPps2eyHnSOo3sba0V0ILbbvmusmQDok1XnAKx99hmQdNwYA51bDRo+dZMaqGILwOIMvsW44SC/OT473GLdQRW3eN9fKBn7KVlq6TSTQDUOQp7ubBkv5zWj0GxJSO3qP/wYeVI7Py+Bz0URuWUEuX55g5cAC8i1Wj11u3+X2XW7f5fb/09weG/U5hjh5ztbg/D07+Of44OX+dyyeqGCX3nfpfZfed+l9l96/vfT+eXnwjAxf/OB0AClUS57YAssTUn//b1lg8DyrrZ2dkVXfD4h/T+nonJrsisauaOyKxq5o7IpGWTTu66eSn5xrV4ccV/dlyqHTPHK68gj3CedyfI5pxRkUxSuzG/lOXTRQ6FJ0ikZmnTYh8p90XtjMh/nJcP/xav+hdc9QRg4Qz7BTEeZB4k5nqWKM/YYgQQRKRqd1NYXIoMBcz8mCPGnMITTsMgb9unPnxzF3D59r0zQJHcdVZ7F1vAfjJtMD5Foheqa6nlQ8Dl8Bq9rYxZYxVYx0dPQ57nNv4oTjHFtyiZUWNcFmKorUKnfM/CC/mSpaMVTOIxQTBDXdNqWvEF61iVRn8lcUpK3erRY3EEjCRcSjU1YIfQHxQ5Mbd0j21fhgq0GCOkShtdInKsSEQdeTGsarx3qVanWfv5UKfjVG7+yQ76l4VQV9DRlCJmmGwwj5pIqX57qmGj8kHLKv0vIvkKitmu+2nLH431LNFPhp6LELNyM2LR3BIiOCDMrRmgaBjlP5q8DLKxyjeS24FhrLGz1BqfkcJ4a8fOiIuakj9oLmjiavPp7sAYOP+QgcqgnwLRQOLM0pnlKOtLzR8nDkJphGoaO0vyJKI1BiIsORCb+s7KgeDftVNIyqyEL4KFzfGNNExCqXHb7LNJR/b2Ftao5GoxDe7fNUDuVcwzZpKJWHArdHUlSYBRR/G8g8RuHcYqWdb1pu3Os2kKvKKOfom86lCtOUvsHdg3y8yVm1Gqk6zsPClfm2bxyfTdmNgAas0brUN1J5P+I36GBrhmxYDL0PTqSAhWbyFpKXa98cRuazF1Dn3UCK1VxGpIOUB2JvwMRwPmyRPWL5wu/XKtOojn0A94NPnWndCe+8a7r7iboRkOOXy4uubEGADZVVN1AJUm5MAc9RyjFjtWuAYKUGKSFQqaEF1Z4N7eZhzGA/VGQWHlBmgRQi0bYmS1Ol7Y+VPUuTyLfVo6Yj1H2oJU25CFuqpQxpmDBQmAxwv4f/x2XFyI3mopE6NReLtGWo+mDDpsZkPAkERC6F7XSPBoD6FzZGs8pQP9tDRFYFKjLoOFBb0atEgmugf9FznuSqpWE6CSzFgOZeBsSMJmXXLE8AtR2VYZkhj8lnRM0+yUu/Z8wi3NCQOXNNE9r8zPIF+AO4WHMGxnFr/wIyiien3Q061VeoECJxe7IimMB3Qa+Hw3HHdKvVasjp9RBEHuVrzeh0evLm3fmb/UM30mOljRo+QMqCvW1WWq/WtB95h+PDV8OXwwNq15WxsPmr4cG5z8d7hXZk1CrhbrB7N9i9G+z+Nga78+KCv8+MgDdU8/s8ydzl/dInb3kIH7qOCaO60TN5NBsOXROWLuybqBvt7ZyQW7UrgVYQMguSv7u75kZ80NH9PT52o9LUUUmD6bwad96YUP7eofFeHd1gO1Tt1Wg5PHB92JOBbzsB/gCUYrdYIbnCG01l1DXVRZ+GynWLjimJ1FZ19ij39T767RvseHjeDlWt4A21gvkFUi9eJesa7XZX6CDgX1Ra75LvsVBBc/ZD+bl7s3FB2Ue5r1FBuAH+D9/NokA=
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: eJztPGtz20aSf2WKX2LnKIqS7Tx0W1unSErCnGNpLdneq6yKGAJDciIQw2AASYxK//36MQAGIEBKspParfiDLRCY6el39/Q0cNeLlA1Tvcy0SXoHvdfaZlZkcyWWqbIqySQ+EJGa6kTjpRVmSs9NOpOJtvR8IC7gjlXptUqFNSmDWIjJSgT5MpKZig6zQMgkErlVVgQ45jSNVBqIqUkJXqRTFRKwfyX/Sk5kOBc6AxhzE0cbMSKw+BwW11Md8vPQ5EmmUuvgy6xr+kCMEhigrYiBdgIU6ChAMlWJhPotl7GFa8Ddh3NcghlFASGOjIABS+CUEjDHOAICH7sfYSWTrs4BiA2IeTC4xDg0yEYF/63qNKnbcC6TGS4QmjRqk0RfJCYTJolX9CjM0xRwFUs5U4TeucqA+1d6eYSr2UBkRgRZmiu6wgfMakCACC+QqkkYRiSAQ5anoA6/q9QQkxlhN4HYRzcQTL+UkUzsDcIGuUgL4wipwCqZhnPQBZ0Aq2SnpCcrFkEsJyoGEaXlnW6hOMRxAVwW2RNKq3ZguIVB18iXXr9ngGTJc8AMQpNM9QyN4VjPdCbjDzKOVXa6VPD8rHUtgLGUqVwoZFfv4Je7hmW9yRcT5gtLz5YMR+aBgHTibOlQJGomETWkME9SJSM5iUHBZZwrYFwMqjiR4RUJbxgMYGmNS/yWA8PhRwJYwE8znVqVwe8U1BesCwiDuVb1ezYE65S9g7tetlriUA0ym6kUxgK3ZR5nvYNhv7cA0hb5Aq7v7/t3BdhYL3TWXLJO68/yFieKpI1mVhxSMVLLpyK4x1jVVz5nQYMMFrjWVMeojCAwmAJMW3WwivXjQZjYLNXJrNe2Njg1kBh4tdKpMa0qKul/Jm2okgggoGxxPv963iXE0lM+Brl+TyUot18IQ/gJq/YuPd7xfV+qWQqmKckBH8tMXiC8BkZry9fJ/555PWHP48ETEACkQAwLj9Xpij0nE5oF2JOy7JtZ9W90Nkd3VUO1MkFEmqxhO1+WcrUADMaIGlku/YSr2IAhjlNtr8beOp0Pxgn8y+zePjI5JOc3hr/KWlxsAW4Pgh9qLawzlrNUKVqW1aG4H2kbxsbmqWob8puyjOalL6/Khz9STBgBtjj91kA6ECfdDh49K0UFjAYD8Q7CGYnN0KpkDtJ5fBcCWsU0MSZWMvGtnGhoMbZTupAxLJZoIF3oCLgGaDNqSI8F7k/MbS0+IsGQgjgDBQyRW8pmA/EB0V+ZHPSPYhU8m4PjVWmfgYFW6hAsOk84GykDhtAJx1oDfLnNitVRTlErDn3OR7SFsDiTOnFZxw2FGJ4Oj1uxxzCKEcyft4DL2uRmbvZayWtF95kgYfKs4EMDQJnClOTCDOtzg3OLm4JZMkexZ6gszjylmIAzRTmTGcBCVyrx2NsyIxGHZyNxpVZ1VmfyStluSU5Ts6CnbjIxR88SUzoNxhi8ikGxuXV2cGgI1KLcZIeAJtrlKzgYWNWJBHuks3cXYvd6f5fThl0ZQeTclUsNs3fv4O//qtUout91EHYAQiBQfoAfJ0D/3DnPJywCyFmcNYFnBEeJfIpIm1i6Pl0es1D7dJIrCrHI+iVoWAaUgKwRPC99ms4Q/g0sLvS0UveJATIYrK10oI3gRQ5qp24hM+rzNWRiBqIZrArQ0nV1dYOQmNisVAT5TQJJzVVibhLPaDFFbNhwu3AK4yE7KIByglmHQOMYO2YKbDGmU0X5cB1L0IUF6BpbMf6aSh2zaH+8uDgTL4fDMjwzk6r4XGftozIICBC3crGM8d5X33zzrdqTL8NXk/3pi+FwuCdfRF/vDXv3lwiS9xMWgewPh/iHvA1ELLiUy2XsvPXurxa94936ombyK2yvMNSl6LkyzdDa82Z8Une3Z127wSLTqe00SDNlmsoVCkotlplzGU3nJOYSBdmZEAC+Dn+ChkKAaEOYg5xOp5Rnb6ZQR215QJ26EUY0CCbFxmo9lmzMWGjjCGa0NJCmlhsj2pJS2gIwujcoYHap41gI3jZTfXK6vFmmvXMJ2ha5s6/KusC9QhpMLL6RK0sefsPKaBRRlJKX3kAjaqqhnc+pJ7rRQ/i6xkfaQR2/fH/kTBdTHbZUcAfObW/Co4uY7bispwm0bFZlnDPYcdnC23cKvMxtPEgUSWpZk0srOCax3i8l+BPHBpRwvxAvjokUuH5P0kQsbXO3U/ZjDnnmTrlLpFlMnKMIF8/TpbFVCOkgr887eXZL4ov3SNJKnMEehEAfmzAniR3ufcEqG0k7nxgJNmPn5sYJkDAgCqLwt/gflJe2eCLQPc1J3JlnsZiXNil0m3BxBH4VmY61GAIrXstkloPLEc+Oj/7x+rmgJLhJfOhNKwoRYSz1wlY6wNLDtMVe2Sq3wOKNq1IguQyeKzpSBB7ggP0dZMlYNIKbOE7ielRO6uNw4O1CujqYFPxrxy5ViHojgoXKZCCYPQciiEyIHBuTD+E6WbCwZryABwAvuA4zfmapEhJUg60bHYX/ZaOdX2+ygONjyxB4OL4Oxxg2AorMjHkok6p4BXQSs3BRuhpbldEvF+vGYbpaZmaWyuVch2Pm2RhzKFBXHLeAVF6DRgUOjRRyAhWNMRU0qUa54+JgesudGDYVsc9ZXsxFE8Rrlpp82ZArCQbA1PJXEGaMqW/pVkjJVpT+ltGoq9TkAhNqFUsdy0Sg0Rs3n9tt9aLYBa9tj+uK2HAjyEtXg2PucloFkT81LrdfgzhRIGHlby0w1Vt39QyWI5UFNxS6AvBP56dvxDnlEWuukqq44ClhliYfRmXTBm+Cwtu1kTQQbzHKBT+c1FLniC19hzHexbCjo10bgZ7ueuB3kMIdLw+p6sic+ZTlWxRHqRVMpCar5KyExbRdHUgAqBBNNnP1sCgrVKWE/7DKQr/HyUd0mHlKzPW7tlB6KzK9ADFCoOhjgLMAEzjUL0S+MFVk9/TGLbI9zpenBn8kNrEEG+KS+gNQghnW5cabbZxzHFJICqCaYqefQVvxrEiEzp4LB7hA9pC94u+MxNvCXAI3bDzcow1iCUDsDYbwWFuz981w78X467FMEnU7Dst95Oj8VNCzna/BxcMzcYTecKpjSDZvwGXPXdQDjBcQ42sB07iKv2gLwrCfHnjqX6GImfoaQk7PvFhBG+MijdrOWRjekpvTHt1tCsExRVTU0jM26ApbEmJz9e8pCG9fmceVlSWAjm6DShZ+xhREOjqAuxyRb18Nvw0GI3S84FMhP/JSCqxJm7jIUJgojE2+x8RMvlWuiVJ4pMTw/Wovrw538BGx24bmIXHpFLVO7A+GgiYURw1Ut6M7OxOJrK0ZSOnKP863cjoFvpUWIjEVO96HBdUK+fLkza82dxrUckzFqaDSftllsSiIaH144sxQHBmQTZgJuLzgglcQKSzMjAuU6tMqk3wljmng2/LQELcMlutslKO1aEDN6BwZaHJRedlYnU0v1kDPKKKg/gC+HtF4pImC6jaGNhW9TKlLk6UTVBVPi01WvWrpcm1MK/kweJynOuBcQ4ripnj3dtQnQysfHY+O+8UBKySeMsswFiBy5ZD3BS6H1UPx04eLPlvR2MpkHGEawZkNYHN++EYcvzkvK28gtH8OYKgIcadC6YxyaTVBgIRx7k3Hn13TBuID1pbIqR5R+bLU24UBEfSbLCjUQQrMFcLaZr+qCeOuMq74lMl0prLamUpnOvwQPfNRQlXRmEK0Md25n4KnxU/kCKkhgzkzNnvrQL4DiNs38G9HVQRv0xwsyUNoldOMDjIEbHhdKttUWGb2QJwWNkbpqyMPpwV1idSYmKqpk7LPRd5wVRAG1bYLUHG7iYWSFDeKJVul/zCJPdyrAt9qPvVnWGQ7t9/6OLkTCd+4WwUQqVhjDrCR6V9+ecwKihpw8OWXDcZXUivZQikIVmIH6yxuG8/bbpVQsIegBXZOyxK3ecVwLJfaM9cPL466EhySoV/UK9fBCjHK4qcPJ8VqHCoYPONXLvFo8EgGwq5H+JL8Xr/XYAbeoZXLC7pLNhceLrXz1A8Lqucux/EjaamvzuM37McxlXyiz4KmfgeYPynw32gPbTUYfN6uREXszpOtMMrNbrGJLuZ8agOjzMcXEi8DN4oVSQTqdgnCUtFpCoqQWE8CRW27kdXwuDWfx4c7Rb7CC6xJ5tNSaAiVgV9+X+uG6JX2Vpj6SRK+p1rTeb5cmjRT0Vaa0ZLcyYZnUULGM6wTzdsLdh4/NvmdEdVLYl3VeNedSU1T/9tXa34+jcH9FWeMmsu7kmvtMrrGCE/tbYd7+9/8cPSzM4XD/Vdf4a9PWJwqBFMyxuXgbbUjOpevNw3hGVc2T5XyOMuFjA75VrqNpB19d7Tz4zlQBfcdqXjFZFKbQs+uLED6WSZyVhO7f8LvC961I1SUxzLDAukDjgXE/5kcC4N8HkhldDALWl8sGIGN+3p1i+oGv04STPsfiy1GGoRAW3g/MdiOrav/2xw34N0leVSi1RqNC1Ba55dB+m+MK8LZpYpjai+aNjQLE9kNZygfV6F/rWYyXPkVWVcbxsKL5dPcLm0mkwY2cg5R1TWKuogrGjW2mUGSx3HgdR5uBM9tp+VxRFCTg8WWGJ9XA3Jo1UnuLz1KdjsPn4qjmm3l4X7vigDxpryxzfVLcH4BrOPwrWljLYp8iW0zm09HMwMpCfURnU7fr3eodnTgtfc1bupVtaUYtphHXcZDZ2S1llV8QAZIMbc4Qn+5f19sRxiF74CbVxH4jzbNrtPwfkPn8CZk6x1RD0BYHBZHzHiSMVFYrFxwlR4NICm7gPvCcowqsYkM7/IiPBbmDi6UHTGhRaZ/uuTWZOEPfKtCBTuD6FFYZdQWXWBB7Ri4w8wb7b5jCGqQCNYQeDF09gsB8Iw7LD/V0g7qGNfnMl9xJ3VE1lH5tqGW30sd/6GM4KTDpUfwk3rXSWGoIaXBKE5M2c09HaU5ni235urCQa+tut90r6yyHTqzJslWhlZ0XLZC3+DkuvzG5T2Bqnqz2zxJpjPq4DmrRjUN0vXGwAj1ACYfeZ00ojzzKHm3h4eQSNCokap1wbvAwV4rNqV4Ql4D2zBM1OTyqgCOuD4FOCKNeSbWikEJil7xmr7xzcdoG6NcdIzXuIGGPpf2LFXX2uT2AcnbCJQIq3DUAZdh980X7p0DgrC2BHeg0ipvIMQ+fYUEu0Ob0DEu3N83fIT/fsj26HXkB6ynvTbCcZe75aseiUrxi+jjALH1cyPBf2RMq3kj2MF8inD1pED17VcfF6g+SYjaf/nxMeoPiU6vnhidnhqXvvlz41LHRqwWcTY4hkvyGw1/7JUXtOWj9u53+ZB41/UL/EVoLx/ZXeqTo9LUpEdYXe7z9bGH2mV/y06kmt0m6Sq1HKLHXwPfVrEom2u/k9iEt8zR+7o3tGCD18G9Wnsqnihzq3JflO8pchnXVeO8NkbXk+wOdqM25u79hZn7LnH9Xr+TVdRZ8+ovr3fla095HDk9kmUYpgr8Q60Yy28Kck6drag/+pBeQIBLqgd8R29noE+kO8gfOcMXFssuS37XsWpROXoOCxQHqMhQoGRu8DXJGb1eiI2t8OOBXVw+FX4HFxY0iAVtL08eq4VxHMLaSBpjJ36WLe3B7m4Ez3awQqtnqUyygTa99deFzlIT5dy11QFmGwTwuTOsq3VMt/y4ichlJQs+dSedKyRSVcP5Rsc7BrUAthb2ytdfqhdrGpUUl/AFNThB8UJP8YIGCGaqbyFi8DstjKMIxLOkqC1mKYQ04sFShup5X6jBbNAAeyDcxL/h6yDIDnzh5u8BVR593bvr8XtCRQdO76cPF+u0ee8QgR1YW6DHkBzOmHHWg3zJQetaHdxivdIboNyoyqeTqSlcjwzJ9YCP0Shby+cW/1PJsxSJ/qG6VVcEX4ca1JSTsNB4rSPqTMD3HKmgq/HvojTwWsN8s5nMP0McWZvLJFRgsGSto+eUY23vQqs1oQFGmQlNTMfPmk8mFdURrQuJv7vWNcjVNCyp+nQMweXpa24UL2Kj3z+WW9KYDBsWISfbIXo18IEOU4qEkTlN2OJR7Psj8Qz0AVRsdHLxvTg/3oFfcJdX85tnsF9td3H82i89c2c1+UUIIQrbXw7KFycPQXeBr/uD4Zrobm5uBpIeD4DkXTfX7r4eHZ28OT/ZwTn31Y6/EicyK3K98V7axu2Cvf3h/svBi8Ee1d6NzRYy8fDBl8y7XHvTHrwA+flLDeTSPn+p4S/3pQbnwPFd291lLDW15ZMh37lU5JfeNXZNczJCbRJ+OuIOVPggJuK2ic6kBOL3HHstAObdHZa13qXx/T3e5tetKVUBifLBYdsL177N/rHfgGhlDLaDep+CoOlwgxOcByP+2A86bEClKAk+EZMHfOBhw+Lldx6euvrHfuJhE27elx6eiN6/0ScYNhDa/qmJJ+vDv83nDDbJ1v9aQ0XpJf5IKTPj7VmR+j/OrXz+FsLnbyF8/hbC528h/InfQtjg69a+iFDz7DzmkITiPVur9t37daYfTrA0IF3doKqZ8Lsu7sL7FIBMVh7sZvmEUcD/vf6Y+pS/oR2Bpv69HM5POieUBQcejfzA8vz/A9duaAs=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWFtvG7kV/ivEvDQGZEm+pE2NxaJe27vVNhsbtZMUyBoVNUNJjGfIKcmxrAr67/0OOVddvEmA7cv6xR7N8Ny+c+cqSoSNjcyd1Co6i95K6yxzc8Guzws3Z8f9IbOxzoVl/JHLlE9SwabasOvR5emHixGLjUiEcpKnTFpbcBWLHuOW5cUklXYuEiaV53fRHBzhoDDsF+F4wh3vs/dWMM4eeVqAudEZCKRloHdEPW5kXIqpVJJ0tZ/u+16xMdNTEOMMd4JBsyJP6KmlWFJTMSP+UwjremwxF+DMYaM28r+cPv4zfLtbElPIH3v+/55wK5Jx/1cV9SL8Nv7sKAFYsVZTOSPILuVMOp5+5Gkq3HUu8P3WowaanBueCSeMjc4+rTbwfldkE0ABE4yItUmAvWb2QeYe5JzPpPLy+uycKTHD82MwUsHexHujhA2iLZvw+IE4jIfjPkRLEgGjzBI/FLTATz2dWuHwm6CQACk6A60VvcjGc5Hx6GwVOUCAo1I5MRMGZ4EgL1IXnQ17UQYssyLD83rdW1VsU5lJtymya+sv/IkImdplsxGuMIoBX7Ja9L9VwaOgVVfytX/gKSJNSSjHpA+NqQxqUHharpKJfgK2M66k9aCTXoUN8e4jsoyePvtI0bPUBbNCJeHbHP4QpheYCfMoY8FMoUIy1XFTZQNCx4knV0knEJOdOhBDjjSwyKoZlwopQQQLH2mBHJ93ao93TGnXocvw2CEWHZo+eys4IozeB4OYLlyFwwYDpMSv6q5tLihsGw2mVboMqUZgUbYR7jHl50KivHA2EdzgII9jYSkQHoRqwbuDQrHzmxF7EMsu1I4/CLvfk2VVERWxB0fOlDaio3Gf3WlyWynnkI7GsJb8xvc4aCJ9DAjPF1DtVcIbML55f8cGj8eDUD0GPEFCDXguQT1Y4f8/xHKUrAclh0NwQDWC/6CfR3z8r8PbYhJcMEp8pSKJiciRTsAp8dEUvNu2qwUWRZ9UhfCZR9DniDAUxQl8TeyD6GszI/4LCGdy2oT7RMOMwNY2MbDL4KxA2IknSQXXP09EqtWMpIKb2Q7X8hAZk+qlSFD2FGrdg9IL1UraHrmnm8O7nVMlj8+DimnPi+py8OeCdgEUlsjpVBgc2NASsZAh1kIW068p2mJw7d/v7m7Y6XBYl94AUlN7u9B+UYmzzkg1i9a9SDzxLE/p3Z/fvPmrOOKn8evJ8fRkOBwe8ZPkL0fDaH1PLG2O9ojWAybHwyH961bDKhJgdqi6Zd6ENh+KHWwrjLe+qsa+YilH7Hiep5SSYDf4bInnqqV4bqjaORk08Fy3dbh9Rhi74vE8qAOo89IfrX4eMqfoVtRqIHlmziC3OJHZFrx68lnE1Le6Wstk2wWb7Wy7lVTWBNVDc+uT62oQnue4MXKVnR0Q5EjqTRCI1dfYDjXCjJScu5YqoRnvMu6JOZmh2yHq2CsIsrBHJfYg1PPGzgWmvZKzlxLmr99DSspRHTKdENoka91OoE/ktArqtq1tje5BUqrEjeFL0rcZsnbFhZPO59xNc2ozWMrgxQmxZzZp23zRCnVW41In9xFpqDFLjjYidR+/Ozrcmql8hDfDepv38euKOen6LcxJaZoyMRGjt7Nq6KslnEBAePnbvN9tqFyNfh00hmA45/bGiEepi7bKE61TwdUW25FK/Ljgexbix4g/AQ6Wlxy2RPjCG6S8w0T27RIUzXOb3J0pxHq9bsKuDCz/quyhEEm/TkOt/uI62w59YYw2Fzrxsun5sqXx/abwzQBuqHd5rbYFCq53sN9R1ppW9QOnBTAvCJlyDSLbyd7tptRptGjaZePvtSferV5e1lwZ6l3MFX2mSbTV1Kjyb4J99AcG+72qFl+RbEHz+g8dhyPIM1gVqwnJi9nAiDq6QNWXbulX+nM/tOPxnlbPH/xGQ63cvyGr+Yx2/6i8JWDhmoC98hcF1LkPICA0bAIJ2s013S/M/J6ec+IUtVaGJPA5DCkxAIRKJgObfF64ga2uHYL+u+4cLkWmS/OoOZqUJlXncns2GCT4doglpC9nhivXlzraXqdvjE6K2GfpHja/xeHWUTud7SO34fOmIvcN7rcUfiFqKvRr94cdat8Mft6+8tmq7fV62Cyefi2m8hTGsXJrHnf4jKuFt1pg0G6m8gldMux8QUc2Zq9QncLu4Aw6tMcg57E46DHRn/U32J6xkvA7WpcIDlpIvx/7OasdZ6so7NE/apNx5Gz088e7bdtaOzbSwNpKvcCp1Jlmyo4SrEbQ57zvjJ4gqvOZ/ObHMammuioePPbFA1VCkm9tkefauL81/qxdIn9qXnUDoR1DG9bURNBbP2IKpx4ca8p3ICzpfwYPBhNKp4WE83P6B2EwRvoLtGZqtn5spjtMJGeYqQ/8sribEFOJrUXU2XxzQBo5HevUUuCgY1FUCUU0tmxyAVq/2vjO1WNznZab6SNJWLIyy1szPzqi9RHjcIybxB56eyVwYNNUL2xwZ4m01/bjyQX7cMFeIR4QYqOrux/Z7eUhfuFtkDa6vWZHb4ZHJ4evWXap40F2+ba9Z0x9SPkWiiYgsFmSV6tkQuwCV6wsW65bLBZ97j/3YfKgpLWDt6OLq3e3V4dEs27m68adBFai46L2HlhTJQtuPx4en/ZP+kd+ctfWZVy19KG7WFatAEm3OdQN7eWS+/lL7jKp6X5ykKccVXRdOndVNqNP0eNxuBJAOyKkOw0p3JOrsI5RU6rWMkvdbQ6nEYfVimS+N+l6Ta/DlbFvVpgA4YDmTmSvH3/fy/OdMDxQp2nu0D05XoQW98WKf+1N+DOqVCtYo8k9/TC+QoWRpGqBXwfuy535y535y535y535//HO/Jkyt3Vz3qm84cy5d0rr29beum5vVz9d0YjMy/m52R0e/O5QPlDNrD6pZYv35hoRVKC/pNBOku8ojxCp39fHw5e9BPXgHU4THvfYPv8HB4UmVA==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWG1v2zgS/iuEPrWA3/LSu16wWFw2ye76rtgESNIe0A1iWqJtNjKpJak4PsP//Z4hKVm25bbAHe7L5kNiSeQM5/WZGa6STNjUyMJJrZKz5IO0zjI3E8wZrixP6TvLuOPMiXmRcydomTu/J5NT6XjOFjzPhWO2LAptnO39rn5XVzyd1TRsKp9ByNnILQsxYlxlnsE/bq9/Y7fpTMw5m2gTOWNLj92KcEZFYePbRqxLSHUpJlJJervz2/QEhxRGWKEcD7LXO3rsroXDKBy61CUdoBgoM7aQbgZGz8LIiUwDIyP+KIV1bF7i30TnuV7s6YDjNyqQFejEHDZl0rKJfBGZV10GZSyfC6+2wEFLps2UK2n5RlboUWhlBZtBfaVZwadShfWKuRUGxOxJiCIwhXILfJAK8qfwgegwq+l5xtVU0PcWz0li79iztHKcC1YqJ3O/z3NgMCbkEy+FhEQ4OukkuhDGSzLMEDapVhM5peC5DIw/eb7XhcD63bbB76o4ApeCG9jACWOTs8+rnVi89g8877F7JWF7JjMIAodAPW9osqDKxvply3TMaVZaEeMJmkXH9dgn8i852vvYr80Ez4TpBGYwpUxh9VIFU9Y6VlaDmk68uOp0BdmzVhk6IQyk7TA+5VLZEMvR2lWUtEpP8UG+aNLN8bhFLHaC5YPgz8J/DwoxXbrKDjsMtiLHqwsK27QG0ypfskVlLF5SXjhKA1Elxlhwg408TYUFrX4SqmHeFgrFzm+GiNLltqkdfxL2sCcnRs/9aiQOyTNV2ogtiZEtmtwWz+nS1hTahixod9BYRgyizTDVQSG8AqOb+zvWfz7uh0jv82wuVZ8XEtT9FX7/KZbDbN2PHLrgMGLkP8jnLT76V/e2HAcXDLNRBQGZAFiRnTIfTcG7Tb0axqLok6ok1bU3fYEIc9AEvib24ehrMyX+CxzO5GQT7mMNNQJbu4mBNoU9wIkXJHMnPI9FrtWUTgU3sx+ucRMpk+ulyHrsXAFDnpReqEbSdsg92znc7pwqeXweVEw7/qhtDn5fkC4YBbg2mQiDDTtSIhbmiLWIaXibcCCcd+2vd3c37HQw6AGPJOFOMBLeyCN43zYtvhOgAAkBfBOeW9FJrEf/5GyVEPCDxDoj1TRZdxLxwgF39O0v79//TRzx0/Td+HhyMhgMjvhJ9tejQbJ+IJYB6S0xOR4M6GcbDRtgTwVFZN+o0qSOxyvliBkvijxWsv4XSxxX+2Lr8ReROsJlQ9jnZJDnYM21LWL+F20DOQDbbZtE33lKyJidtmO3SteC7PcCPia/WfY9NhKDA50G4W4EKN8J7Fk054ja/XjZVfPXcs5VlwCaU1neIMRXHE+HbYLuhi/nlA2kHYVjOO9b51Iv1VJtD5/J7n2hgb7PPEel/l90a6SHKudoDNAmeC0e6VASFj+PfGqE8F8BoNpk1fdM2jTXtjSibcsfwlZcIlM85Rpt1aOR9umxITAWALIavdBjqHMkEPwBcnGQ6FHhz9mj4+Sh6YYtBdYtgFHHOc8yGdqem0bEOFOKXSftRfQm2OHWMnUwQd1owy0yiwFd5th2yKVVAQpxu1430e5zjNsYRrUaD3VgJdwYvtwj+wqAPKxpc6xLMAi9nQb8+270ah4ljNHmQmcknn++bBjtofMNpNtQb1wjIcXU14PanxBw3cK+Ja82IfATR+uiCtTquumFnbz2+0C/VbzgjVhMO23wGQqkz/JYMpFQOn+mkulb4H0KGVtMPypQou3a/+hPbP97Rf2rNvLfItszzbs/dWgOcZ4BNFWNiD9mx0aEbiItjXRLP9Od+94Yj0CJVfKTHxzOYWD/hbTmUxr+kjg4sjA5sjd+drw8/XjxFgd89BUZYoEA8s00DZ1T4a3EiVfS6M1jtHdDtPdhRCWzvs2+LFy/gURdwrtu1sAikpz0ahtGL8VcR7WxrzQ5NYrOFfas38+w1sUM0JNTsHc9qRPSdZsB4DwrA9AeYPMtDreOxv/pIXIblncFedj4wxeLEE2VV+qwCCPMoRb4PGYEj4VxW7B6OtvMffUVRugHYrUZbfEZVfNmNT+gEwh3JGHkCjKyEXsDsBJVuZK5t0HBU/G2w0Rv2tthe8Yi4Q80rZA5aB78cdSjwtuMv1USxtiftZlzRxX1092+bo0RF+lhbSVe4BRlpkFzSwhWW9BjAdkwHJbUeU5+85VSqomuQAWh6ZMdAzv5NrbGf9/4s3aJ/GXzaTsQmjG0o01NBLn1Mzo8upNLNeEALCzpd173YtFpIRH9dUpIQ9+LXgDUyNcYgNjQ2pIrTKhvrn3GDt/6vqOd8KbZ7tVZfvOWJHI61bmlwEElo6gSimhsrIfBtH7SkzhSdNhM53Ew9D37sq50aUO80vqIcdS6mcx2vb4SdmATNPM2uDNa2kv76eSCfbxgbxAPCLHh1d3P7Payizd8DacNb6/Z0fvB0Un3HZtf6rQ/v/zQOJO4IKT8RIPiIDDYkVerZCr8pdpxb7DnusVi0eN+uQeV+5HW9j8ML65+u73qEg01W9LlWzHgjZXptKy9B9aEZMHtx4Pj095J74hoC20dutiGPHRt95VBcjclGtXv9br49br4+66LI+bR7WkfLkaRWcfYX8UK/jl5Pg5XFqjhFHNbVTzcOKOOE6JSJSeeX6vlKHszRDrxXa3G3Ip7k6/X9BluMb4fQYZw40EpdCdV1fPFH4bFwuaK52AKvN5Sv95Sv95Sv95S/x9vqVvB9Ina+f27at9/Y8HPE2HPuXdKY21vhF03x6xfrqgr5rFl3owLT35ciA+EmdWSWjZ4704OQQT6TwK1kvxAeYRI/bHeHlYOEtS9dthN9qBrpf8As2z8dw==
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.


## 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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><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: eJztWVtv2zgW/iuEXrYFHNu5dLYbDAabJm3Hs90mQNJ2gU4A0xbtsJFIDUkl8Qb+73vOISVRspy0Wcy8tC+JJZGH5/qdC++TVNi5kYWTWiWHyTtpnWXuSjBnuLJ8ju9Zyh1nRsy1SS3TC/quzZIraTkuGLILeGOFuRGGWW08iZzNVrQ049axXKdyIee0njmZiwHjKmVFGc5T4lbAMn8KW0hj3fB39bt6K28Em86NSIVykmev7+ZXXC3FJJ0yp2E9T5lWmT8p4lErwZpdTFpbcjUXQDMZJLoQhjiZpCD0XKuFXKLoJ3IpHc8+8SwT7rQQ8P2i0cMJqAE2F9zwXDhhbHL4+b6jwPdlPgMlAAMVL8CkvZYFW2jDCr6UKqjsCERewu8b1CUrFUrCZ5lgNzwrBVsAD5bN+PwaKUzH0yEcLfGIP0phVvCggAt41IuFFQ6ejfijlCBxcgh7rRgkdg5G4MnhfeJWBS6VyomlMLA2FQteZi45HA+SXCqZlzn8Xq8H9xXZTObSdY9sy/pvfocbmeqT2QhXGsVA0Si1GD6VwV3PVfvkNzID/aN/RSYWwTMqH5L0YSFhoefHSAHK5swWYo6+yE4nJwcfjye1c7Ar8AFtVgw2mtU2hff5YtIjjIUD1TLpYf+UfvBsyD4oCdRjVkN4WQiOmb5rhRmKUVpBnuSAVYYKhaAZsk9XQrGVLiEGIabo2xW4kzADTwwiU4J4plQ+2Gr/Z1LRCwgBJ+5cdTpKmvbygAS5A41B+C65VBCyuOGWIsZvh8+93GO4K+1a+3L42drcBZZ3goPN8L0XiOnSVXroECC4uIjFhR021oYHittKWbwECqB3ACWQQLor8I2Z4AYW8vlcWPTja6Ei9fbsUOzobMKuxaqtasevhd1uyYXROX0Nm0k5cqm0ES2OAVk1mi2cs4NL5yAt2o1vMdBMkg8Ioguq2soECTA9+3DBRjd7I4+CI54CHox4IWH36B7+/0usJul6FCjsAIUpQ/sBf6Tx6X92zsuZNwGCsvRip6KAOAQ9peRN3rqxXJGy0PukKgUBB6q+AA9zIAnYGsn7o0/NEunfwuFMLhp3n2kQw5O1jQ/0CZyX4HbiDoJ84H/PRKbVEk8FambTXcMiFCbTK5ECaiuA6mulb1UUtJjKOjHcb5wqeCgOKqI+EbYp0DrPnVcKg+y5EAYWdLgEX8jB13wU49OCy8yb9teLizN2MB7XQOaV1CBZW7VfhdAVqA0SccfzIsN3P718+Q+xyw/mL2Z7i/3xeLzL99O/746T9SWStIVWVlgksjce4782Gka1g08ajxQgHv5A2tKQPjC9DKjsAF97sORARRDSKYds8KLIwufRF4u83EcCFwZR0knPuWuXAb/6RNEjzLdw7aOAG8NX6BQiL1yAJ6WrLJZzByxZsqETuY1soWdfxNxtpOUtLHifQhYw3YGyoc6QKQVohcicnfFVjtwdNUCHZQsYEZ4CvnALrruQCjaG7EGVEqTSs02jQVIRyiKUY+XUUqlMN/2qK8sEjGUgU/bk9JAutrjJkE3qQPMAmFeVFfA/7ZgTcAVCO7vlK0uZpec7RWGaGkoLdak5xEjYWPy4XJt5v7ZOCIUlFIa2gu+tQn6gNAhyRpSCUQoOEBCURFUyYGWhocIinnuLmMfNsaH+nhK7rqLafod5oStGg3A+FLyBYCWgoY8Gz4gPikbtMTRCqPTV+Sikpgr+NMLLpwlZ+fdxwGwKERKriaE+M/V5xytuxU8HcRhT/G9w4deVBupaNdcpntDVnuffbga2MMh+2qq0sBjAygC1+duni46+p6rMsmmj5i4lULI/rQ+HmkIXeiNSjm+gjpyD6pR7gR7Tej/yfCQGqC06i0DIF2aN4Fc6w/IOv/fpvA8zIZalr8LPIlRyphSP4ikImWlO6FdkWH/+dn76fkAIH5JiCMCVEJTb8YnnulTOlwZBS4/YIFT3bFlVwNW5PQDmvWXaJ/zHYMNICTOtM8HVhg2mKP4DXtALRVfcQn560NeQq5viAm12IsiZ/z+LBCK1QkKYPsFZvioK5rrM0lCy4cFeD9QaBChFBDhykVC+Je6D/TuqRCAs8mKAHmSBpEqhnQpC5LpBlygdhEOqvq/OPWWR/vmHUzXls0SXg3VcNH7GnN6XD7fkmy0I/QCMbPfu2A6xWi4xImKgJZSqxjB9fuiko7L2rFnVLV1CEQcrxJbpRaz446jkY7Vx6vp5FznUjmeTDq5uo3eBi6OpC+Ex4zdQ+KPzx7T3XlTEkdenEEemcQ5lBc7ZWDUWqk/YhwP8y8dpv++wXA2HWtoYA0HAFIjgG6lL+xWwNQGkwU6T2kJwWyP+ZhFlA4WNI6i38ae8h/r06ScoHJl0qSNgrdfrxu1qx4oDZUs/0fLNS6ISOlvgEp8OfAf11V1MfKYwRptjADBkF3+fREJebvLb9vlmd5+ha/GBwXUP+Z783zSQryiZFiUqM8xWk7XX4War2Gp/AYqqdjz0V2GY1OmxsWzpKnL3O1bkB4WjLG3kfwk626p58V37WN1yhuRHx3R0BJsgdZZGuhXdARzRmAx+XuKw9xXNELGQpTcoNV/iZUES7heYT2zsWd1YPIcDJlRtoJKAuyuNNxNLGuxjJwcP0ZAu9XR2vLOPMIvKdGTTL7duFCHLDhZoFmfTJErffcWJyHWQFNOmyXBM5FxhD0ejFL7t8EIO5RJouqHUyeYsG2q1tPTl4BYyj1E4dwh5y23brf/cZeSyMcE5eqJ3oMoQTXPlX2wZgB2FIKiyfJuxejbbtCT1ZZevGUPZNG3RmVbT5mp6CIloIe8gf/qBq+eRTdkzQChRFdUyIx0UfC6eD5gYLocdsocsbPwZZ5WoDpwG/+Jr/tjl7hM/xH6jTc4hfBMowTdliwbcEBHWVux5SoFnrBFbTLBagxT+lDNpQ1KHNtqN6kKpFrrCEfBHiu8c5MT4LItCG/fPxp61SeTb5lXbEWIf6khTbwK+9Y1MsR+Bsh1DHzQs8X9etwOtpp66tqhxOK7rVMsm1UDjWbgoek7dXP/GVsdRB/bZc+TI6bnOLDoOpCX0KqFwjw25zKuWhhnUcQyoRfFjYeq9ViwEfDTpwEEVeYyDZdykdofklaAHtsj0rfXmDJombj/tH7OPx+wZ+AO42OT1xRt2frIDT/DWnzY5P2W7L8e7+zsvWH6i56P85F08XVmQS9EwEvKBUJaAugom8F3Q695wvGG629vbIafPQxB5FPba0bvJ8ev35693cM+6qbwbc6KyUj0va+sBaUQyb/a98d7BcH+4SzW9ti7nKuIHL3Q32tVuIERp7nu5/A5xivd9I5pfUB+J9roPqeZzcrPnR+WQbFBjrXQT2jZq9SjltLuykHQAn6/AJEjs/h7bhw8mW6/xtb9OpVQEKoQ4aK4btprmz71W79XINeaR5nadtsMLn8C+mvFvvSN/gJWq9XoiJ3/ZnfkDImyZAjQSXeKDIUT11VSVsr/NXX5csP+4YP9xwf7jgv0vvGB/APU2rtlbCO7XHJFRom8bLfc6bgzfvsaSnod6v+l1rqnXCT8QM6tPahXR7rY9ngX8iwz1bvkZ4wg89Zd6uf+ydUPdKPjVqA+cZ/0PZIZYEQ==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztWelv4zYW/1cIfdkJ4DPHHEFRbJqkXe9mZ4LGmVlgGqxpibLZSKRKSnbcwP/7vvdIXZYzF9r90nxJLIl8/L374GMQCRsameVSq+A0uJI2tyxfCpabwuaMF/lSG5lLYZmO6YM2C66k5bhjwKbwxgqzkqFghRW015a7E0dNsxVPZMRzwaS1hTCWcRWxlTAylvgkFXs3uTh+fz6hD+8yofDxmsWJXtvBL+oXhecgOWZzboDoWuZLlq81mxcyyftAoXXkkucEtoRmRF4YZVmsDRNw8KbLxoYt+UrQrsmFZbPRjMDMxrOe+xHB6nkiIniehUYAO9FZ7hcVWVQ9J2u+sWypE3gf88QK3FBSg/+IAU5JnfC6cq7ANyEyfyILdSoYj3NREpllfCGV4yPXOU8muUjtDBYWqtRlU05GhNpE1jGVI9+xTBJaF0sDWICeqGXOzULAS9BgIdAEZolMJbApLRuPRgN25pYYv2IhV8DCP6bTa3YMn4NeoDNhCN0kAgMLtYrlAs3sQi4koP3Ak0TkpPJoirI486LYwN6MG54K4NUGpx8fd2z1bZHO4VzA5FlCS7P3MiMJN6QCGJVYwO8VypQVCkQZoSo9ZlBSYtmch/dIAVSEsCUe8RsYK+JQgAIedRxbkcOzEb8V0ghgiBTcC2wIuuDB6WOQbzJcKlUuQCqwNhIxL5I8OB31glQqmRYp/N5ue48lWZLo7pFtXv/NH3AjU/t4dsbNQM5Od98KcOxQtU9+Rz94MmC3SgI4JiOhcnLcMiJYsKS5fmjbK+CCeOCNHYwFEYEhDdiHpVBsowvwTTJA+LYEfQjTa3tsoZzxVvaDYQJfgAnl4iEvT0chRnsx9JwrSbT1BZfKOrdak8W57fB5L3r0DaXz1r4UfrY278bCK1EGEMcQ00VeymGHQOVfdYDiqMxaGkyrZMPWpbAwQKDcQ4yiFPw4mwtuYCEPQ2HREO6Faoh3zw7Fzq4n7F5s2qLO+b0L3PtlERud0le/mYQjF0ob0UIM8Uyj2vw5fVwaAreoN/6EgubSBSGiC6J6EgQxMLu+nbLh6nDoosiQR+BQQ55J2D18hP//EptJtB16Cn2gAIEK9Af4SOKz//RvirlTwSSiIIYnRiIDd6LwitbktNvkqyEstD6pCkGeh6LPwMJy4AR0jeTd0e/MAumv4XAm49rc5xrYcGTrvLaX4RTTgniAQNlzv+ci0WqBpwI10zVXvwiZSfRGRBD2FMS6e6XXquG0GPd3fHi/ckrnIT8oibqs0aZA6xw6JxQWyTgWBhbsoARbSMHWnBfjU8xl4lTbzBgUB52Q6tjbFu0XhTibG6kWwbYXiAeeZgm+e/n69Rsx5sfhyfwwPhqNRmN+FL0aj4LtHZK0mVZQxSCRw9EI/7Wj4XRPTbG/WvLZtZGHGJQIHPmjAKZypM6zLEEPhc/DXy0e8djlQ89/FSEmiMxgMETy9LWdLev13BjeTSH7iw3tY2phSF+UP8jeXS2AlUOZaSDY0Np9FVcPIpUMl0+WUKRWrEv2sdXGebaDcrM/2E4ArJYq9yZXY+kWf64u/VwVOugIWEZdY9pF+2RS3GXCSXHAfi7z9ierPJIjZ7e3kwtfJj5V6lYSryHsKV4xAIVcoStjpukxV7BCHtCLRUJlUSQgKBKp1FfXaL3C9Ju8lbmYpFV71fxVNI6P+WH/dXgk+sf8zbj/Jj457I+io/CleMXH8+MT9EMny65MhcKi6GNwOb2Z/Hd6Fdx1jBc2tCWL3LcjswvGwLynMmMv8Beb3rDx+A17OT50W0G8uPmAMmybj/J8gEql4ef1f6Wd9+4D96Mr9BuAkFbP5RafeijuwTr8f8Nuf75qEfJQWaTDIgUttNEu8zyzp8Oh4esB1NLLYg6Wbnx0GUCjMLz8cN6HZ6vBpot0KNZhn+j2kerQiNgOMc7aIZYmtHp6NXhIExSAi7uf4/9tlS87Ju+040psic7GRJqBJzhKrrSh2EM2T5U5GWVZKrIFmrbSlJN39HTLqFdg2Egg2LI3awCea50IrjqIqUCaAVbsy0gVu64Kr0p6VSEIko2omAW05A88QcRl9PA0fISpOuMnvdY3ib5y921ii0d6BZxVnWaDNdcF7ItFDyyXKcgOiLAXcKaFaKMie1BKew+3a444FgALUnb0dbhHbczjV8evRuPxy9EIgFct8Z8JPOHwKtURKuEPw75tFhcfMQ34yFVGBe8cTeU0+W2Y4x0Sq0uAfdkvlznZ9HW9ajcR+ewMK8QTHVxTmueNXM4qideMYhyu5gRfQG+KixudJ+VxxldQuyGTTdqHJyVxxPotxBE09uLobhBVy9a4OuEIDnAvP0/77Q7kskFuSQNNdcnttRErqQv7BQFkoiJqqqiyhwBmxN9AHCzzFDpHlJ4Mp7yFvvXbT1DY9e5Sx0C23e7abN6dpFTWdUerfRMCaPDp2BW7X1yZNs8SxmhzriOChb8vGszc9T5Txda79ym0YvOYYkqH/L5aosoSP3DoU1VWoND8HCnYOll1S+NWGTa5KBsfiui95tzAf4BeQScr7IggDTSGYn4aBuWdogFZ0BX1+C8s6lvlA/jvIuqI5uQvbYUTOM8oiIZY0IIJ0TE7MoJNkBkL1/B9fAzOaOYBP+9wcvcDDYTQ7ekNcs0XODoN/LCVuWkre1GO2M8P4ABXSp2pEPSCogKMS43D2gUNOzOO9ILG3CVy1PrOI4YgSCWjoassG81lgGCRlX3T2wuRas8pJk+TNAraCL71eSYHcmE4lLJSB93B5LXRURGSuz5B5nMUbnIMiountlv3eRfIXa2CG7REZ0ClIuom3L14YprhQ/PvZb7faYHLQVs9wqtKymoQT51Fi86sHB2WoyBISbF8gEzqpmcOI4O+CAKY8CU7ZHGSQcZDcdBjYrAY7JA9ZX7jdzh4QnHgaO97KJ/AGpsm9xi4iST0PSkH9w3++WHa5a0xrQSPsLaE5yh5zDgzbIFglQTJ/Sl70oagcm3UW4AeIlWsyzjCQ4ojEDAk6tYWWQbN0N9rfVYqkT/Vr9qG0LShHW6qTYBbr6BTxjwNnVdGvbTE/9i3tVpE53vUTLyn9oGuIs6rvsKyibUFV9DSvvDXYgeNe7HdjVC52OqIyrGvDxBRrkOdWDQcyExoVULhHuuznRMtzUZoJNKjW6tePRfZMO/qjbbHQi9EFpPDMm4i2yd+JcjB3dc5dXpJE9oPR+fs/Tl7AfYAJja5nP7Ibi768ARv3WmTm3ds/Ho0PuqfsPRCh8P04qrZasVkUjR1gHwglKVAXToT2C7I9XAw6qhuvV4POH0eAMtDv9cOrybnl29vLvu4Z1vX4LU6UVhl1106KUYyp/bD0eHx4Ggwxr2ZtnnKVQPPFU2h2t3Krh80stzzpevzpesffenqQyLekw2zhEMO2nrXePT5/GOwOnSzaMjo1LI2c7q7t1Wu9e3kdUiBS7B6JPL4iL3arUm2W3ztbi8p21cTGT+ef9L8/9x73L2SuMdUXV/n+llf4GqELwb+tZeyn4BS9rk1kjt8MBTiXXlX1hBfJ9zn69vn69vn69vn69v/4/XtJ8Jc5xK3FXndmjNSSuNbZwawbfaoP11ij8F9A1I3X/fUfPkfGDPLT2rToL3bhzkI+BcB7d3yHfoRWOr31XL35ckNVefiVqM8cAT3P3Aw4vk=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztPWtz2ziSfwWlL+fMyfIjziTj3ds6j+3MajabeGMnuapJyoJESOKEIrUEZVuTctX9mvth90uuHwAI8CHJdrx7U5upyliiSKC70e9ugF86kdKjPJ4XcZZ2DjuvYl1ocaXyeByPJF4U6mY0lelEiVyNsjzSPXEqR1PzTUyzJNIiS5V4M1dp/+Tg/Vn4eBKP1Wg5SlRPXEyV0CqHn4XOcpinmLpRxXApBot5JAsVHRUDIdNILLTSYoC3vskjlQ/EOMvpmSiGp3D03sf0Y3pBo+h5lmolZKIzA9TAh+PPgFiWL88LWegBgQI3j7JFWqhcwwcESsH/liuRF9mYAMjyiUxjTfd0RZoVQIFkST+NFnmu0kLMJTyFWAS/WmyLqSyEnORKieu4mNJv4zhBYBxO5jsANxvGqblRiiSbAHSJOHp9wiQd5OrvC6WLM5VGcToZdEPMX8o4URFTdKBu5kA7+DZO5EQLmcOKTIHAowUsB5IXJpsB3hrotNAOpNocPFrTNEjJ6zwuFOE04IEGZqQuLLyIMqIJrC7eMhNFNlHwIWcE7RMGtwBgeBQ4Ah++zvLP8GAkl38AllIiBvA9TnY0NOzmnstVschToKJZT14HeDRRAHE2Vzmve65mgEhE4wy0kvloOhAzWYyAb+D+ucwLywvIbDBFKme83nB5MAd+BCagsU4NC/UjwKlflLAkWfZZ4PTpUmREgHmOEBTLXsD1hfyMciD1CKibiwHiOfgDzW3QY0Gh67SIzMg85pVMFurhjDIyTAy0wYnVDV5JsmuVjyQsJM0iBkW+UAMgWqfbcbTsR6BXRlk6jieoXU7iSVzI5INMgOSkM6L3dTl9/xSGACoDUZEBO4e/fKloqteL2RDQA2o7mcqE/hzPiQIgfXFKA/bEkUjVBD5fodyKRZorGclhYoEeAySgfuQIGUoMdgc9mDrGKYBY+RK+4NLC12w81qqA70hGJE7nEJ7VqtvRwBYz2Tn80imWc7w1BrUyUTncG6mxXCRF53C325nFaTxbzODz7W33ix02iWdxUZ0yxPWv8gYfFGkTzoal54qwVr37ArjHUIUzvySxpSVfaRRQfcNNce6ZAaf5jTYhYfoJl2GW5Sj7MiXDwcsAmJB8sTiQaM164q2aKxARnN9xQxeXcYLjEFj4tBYxj4XqS25rhTeDJQEYdBEYns9KzVGCedLYE8fPaXbdJeYnpWCgmqrUyX2aGXSZw5t4hDFtWgIQqCSL4B6UkYYVkXkucSDQnDPtXddFDrIKP6gUWeeXjhHiS1QwZiL8CpApoEmEcuNpn8s5C3v1MrA73PsJlhwgk7N5onDsxlvamAKW3L8flOgYGJw+xhFcBW5B1iEOzWPQSW0uguUhFFwp9FyN8LfwHqDKPIElbRNOH5ITB0g/2kgaDI3b+R9QjYGMV3G0AMvbgp1FQ2qdjWJiP2OyHUrlIG14lHd8Rdhnco7qYQ3cSZzCguNPjRDTKDBVG+Q8yVeEujSu/6bFCbB3WuQyiX8DGPslJlsn/ZMnbTDx4ycxAnUHGM7J4APP5eidGN8FfUxQlKjq2oSfHnsg/ucZuhZo+Z27yxoe0LYrtQW+AIs1qkJ8nr+10sF5E3cBrlQ5OAN8hVk7nzyLwdd9W2bd8GPUdBVQavOuWnfUo9YyGD/raFGApxr/xvrgLau9QLeD8ge9r9C7jrV5mH3Kq/lF9lml5iEMAsBNEe80WQBaYVL7KnALhyrJ0gnZWDQt1+SxuEijt46lHEl8n+uORDlXBB77VZ6xb44nriVgY5mGWb/Lv8RhrEVEMS7+wLcn7GBWTQr54jAEueDOv9dNDn4jVYZZliiZBmSpO56PRZoA2bqBC0IZ/ArTgrLDoWnex0DeONePhvE00y3yIszUK/hCOgY4xXuXF/EMpotT44SBzKEf9913J34YBwM5/0wsVdH77jvwu0FTQJxunzVSOqNwpgx4rdhCOCzjVGM4ZuMgDqoIUud7cXBPgaQNUv6DKSKTa7nU5BmCEQYfdTaHIcgnFheejJunLNZdgQGBwW7CGiNbFIyUARFZxILZRB0Xw9vov4DL5KfS2MEjFCQDdGUShd3J1ZwTssIb+gBehHiXxn9HR7Y0iEZdaoB5mN0EqQpkGlwv1hGAXm616Af0c5fZAhaJqAS/TQFyViC8dPEIGGWR8tKVkbJZXAjwCnXjgmJcuKgRBsd5Xbfg+IDRrvQ4/NwIvc2m+M/N4GPwcJic6YlXSppIgREStLaZTT/4AwRZA0IXntA+NVjWri2x5ALjgwLVmEvPDMEJQI4ZjZRG2wFmxyNvwxOpODrrQ1yyDEldODFppMU4z2ZsFvlhIk48STNn/xhiYn1YNjPPNt46Amxx3WTLAg2tpODNQKpWINi4nr27EDtX+zsc4+/ICOLcHTmP4emdL/D3L2rZj253zAjbMAKqE10AfJxf+a/t88WQl6APwmGUUqRAWY/IjSY1QKvr4+URC7kvTjEORO8VSD8HDisAE1hrHJ6nfpNPcPxrmFzE45LdhxmgwcOW2bdGhGcLUqEQVHb5M/sIOCuMltfZ1dyEyCTZUkU9cZSKRYqxph8lYdxZkeHmxXFqG+XADspRazhC1YORIorHY0XKKYQySUglsxTjtzGYY17aP19cnImD3V3nVjKRSr8yJO2dPF8v7ux8/+LFD2pPHoyeDffHT3d3d/fk0+j53m7n9lPX+ZQUFO/v7uIf0jYQ/sJHiDoS40fs/KpRO36pT5oNfwVDRDEwWZaYR2tIEOPlUNe+X5n3sO6Wn/Zl3qSAHpeK7RApjdKKUe5X15O/DRkAB/zmcDEE1pnNwdHxc/QEND9OebAzP4rfckH6kyAC73oqp9GzMIqiEtljyFTNxrLfok2a0hl7K+C8emQjOY9pbU0X0UTRHkSjo3lsJjYOHF06y7MiG2XJALN+bmCShamkBA5HBeChmCIBOQS0QCYbCKTBZDLS/lAMPnY+dgY2MUGc28UUobnC+biu9RTNVWO3Gax0kSTmB/DUaCUFfyH+YNMfcmVz8rgpPgsZotUVaMzc9cRPnEJzoZI0Tm1L8hpYG3i19PLIAZWgfGzyHBcWRoqxhuO5lSanRpyP4QRQ6OSYzJYr2jDRkfdLnfBC/TDalT8cbD8dPo+2D8b7o+0for297f3xM7k73Bu9iJ4q1CLxBpTpY5UH3CUrEVU9WfNOSVghmEKVoHwfuSdeZ57zw6bGDzg5qmylIWriKMrJNSgH7YTKcH9veDDcHT8DLPdBER6oZ+Pv5XNE1sSxf8spwF6Ld5lvaxbZd2/7QqUjGCuiNfjbW4FfwFToeQLKi5ILak6ZIVYpLh9jXC49kiDIWDcCJfzZEAKQpPyb5YMgSzhOsuueOC114kJjHqPKEjOAQ4stEOtLcCFM4YM+9369LgZPeh45/LB+PVHoNo+PrQZfQ6wueozEx7BkuUpKJmdaOk1eJghqEK4H7iWoi3WQ0LJRjWOZZOBDfSVi+qsE/tgs1jpmc7raDn3IObvIWtYp1cColOM5HTj23H4yECfHf3tlfT9ys/ViPs9y9P8oQMaFmhlXR9DNVeoYbEegWWNO17cAQdFjUTdIRltPwU3y6mhhHpoLhs7ctyTAdSHzQqMVMoUGbW91ZTS0B0kkwkLkSf9lCLRVHv7gM3DCsDSCkaUPAKmXiWJ9NgIvDLUcWKawUrnO5FzqOyx+O7z1JScUZ3KuV8NnHQnjSs7gJh1aMvT+/4J+AK5RSUNNpO3VkCspd7mRsajZzwDBsrhgbQe6LCWy40UCvlyiSabsyFl+CYjXfcsj8hFhmhN3o/irnAtMdSMLm5S7TRaQ+IM8lLQjXQv0SbJREI63eHdInDX1phZXGYVPbqDAjkvQ+BFLRC6iBbBvqd6kJwaggi6vRpfovGNJOhr9u462US/Bl5nOLmdRNjI66n7r10/nEAd6JHae7PqVxZUAVQR3aBiSVxUdofVw/Hz+5vUZukzqBsWLmGOexRioTiyPe8vkEQ5Nyep1NHkFC8xlSnyxXlxfM/+QJxd59EAD7snjNan0CJlJpVcQRM6VWU1tFu3nDxcYw4MjBUoLDBV8f1KXvAczTVrj998DzxioH5d1Ro384qbmVeth8tALyn+xS0JkMeB82vSeTShZD0JcsrHFGNdhDBV2TYsSIAAQPGXK7f+oankV2VeVDoeVAdfhx3SvVym3HPrlKzTrm3ii7Im7iB+rPrpS9gEbv99rKOTwfGG61FjdSVZQwho9+pQLBG01t4/p016llGLoFk5ATpCyhTXjnQ0XRWDKIdjgrC46LpKy7BROtjh3S/IWD6rzcynn0ItRBDlbq3SoNFlOBwkoL0zaouIr2Esqo7KAj9CxN/Wihnx9lUveUhKkkTfMtTZrHRQ3p4oDLBT9JQjDBJT0NB4JHU9SYD54rltVDIYrLaKGYqhQExnPdJBIJ4+aHW0DVYtvS3oMJuFOTQ9/zoY0aYQbqocANLO52AJNpcFfSyP9hGMWDp7rDSHARlqYiWhS1x762JMmEogCQROtcC04CtpL7mFa2mIGii+dtqzAxpKHoGTUM/fGy+HeD4xSyzQkmE34Hq2BhUWt7tceZ4BfbGpFEGZLWDhpPI4hGjFpFZV4iXEW2vTXEktm1pHFT5MMfil6o9JpbXFOORt9dxL4MPQIiJP+CSrB11RwGCIOuCZo+kdJjArFIROPhbyScYJSWzdhBNGnCuNs0O3lEJRRFHON78xDFQudt7UYTHEGx/fgXFrLKEMn+kanTOWcKioUWLCjMs6SJLuuBmfGIevZ2HgBVxN/ZJnqa0pc+9kOVtabd7fVcFrp93roWUsDN/hZ97Ir3eKWM6p+5GTHaE6ySP2ZxbEBdTOrj3qRwzdJTeknwB53W9Iq9hflYIKYjUprOZZUg74oES1ycgkbk2wNYP0otfr+YL2o8H2LPOH0IDUascgUVdDWkJFWwpoMQ/q7JLXrQustITiQC5mOPGeodMIDnWU8kS5KLVVbgD70NHVzeyPKcVO7a08ccW8BVwpMD7RzaWzFHWuJLjccGG/KCGBCGewQZg7zrrVCqkSCgDKJo85tWfi6IAKtzfUi/cV+b7eECx9Y3T3lOcpX80sSLnKv3cdIYX310g5JKi2OSMo3TT8LMAYp5n/gIz1YhlJW/575qTEizMBHnkrCAwvVwER1NJbRfQ8TN6tATULVhYAW3tBakLICzj/CCh5mp+7HxiQ80o4RpAHr/Ov4O3CHNLVb3mtuPR1mMqctNli19ts8uf/Cue6rzH/Y1rKBK2x6lxzvYwfPgL1R2jcRpstp3f3GIz+4wDDFtB9hr4/p6VkRMFEnDrrC2BNeyintr4FYPyiFWQCXRsdbYU55BK/O5Y1j+o9MV5btHqvSiTqG7uzAlv5rSbxVDV46UD9eH4upcloJXLMAPSp2uhltrcPUUmmqZVC92nt+8Hx379n+7m7F93mPBIuL5SP5QO95PWJXc240+ZaXPLi6ZeHGBVIca3E0xTjyFRdIwfpnpWXBrQ2Gw+psIUy7oBSpujbUx/rCZg4VO5396BxL4hsYgWN2UkFzURFdcUxhfAYX5xoyrEszBFkU3nJ3Cf4GTkppGTvepSwKZFOCodu5ebb7w6WW6WWUavsVGGZKtoOHOct08dYM+Q5GXJ9Vetv3HS8LDne2kMmew5DWFWpOHXytOpm9+693LMEGs0AshN3lEGcBGFOw++1woxKMVBIDuVV0+DHdBph4MRDnwWF5I9nQq1hy387Zm/OLsCmDCrcDfy0HrtsR/DzMKsS0dy6cgnBfPY15GnhNIqv//OHUjMKE9B52mFAvLQH34emxMLvCvCy4pqUhdxOrgA5QGNsHFryL2RwIhpECSTI1cw1Qll1v7yK1X4PGEXYteP+QD24V33uD3EaVWObbjWtXTPNsMZmaBDQwCDraV44xdKXhpkab6iLaiRpX8L6TNWLlbxYoOafT7VT4CK8Qkd0Hc9WC6n2kXz6Vubb8yNMzawXvvdV23lNUtmDkM0/ldjHzd2W1hycr0hdIdjv97Tn38LyqfpZXhHb5ytb2KtNhOl/oKWZMvfDE02wuErHG2uZXNSjOgQ8/+yZu285abE5vTBdNvcPon42WRWJQ984fGBqEXjohxw3mFAyDCtctKTvXZ4UQpRkEeJvUwfzELj3EFnwzi43EVKlGD2YM1maaYpsRakBweK44yKC2HrDX2BHItPLb5tZD2Kb0XIAyN0P5TOL2L7mVbN03qDnVMVnkJhfaaKJB4TjR0mZAM+2VzGOZFkw259qt0tdbg1RexRNZZHnPS6H1JqrYejJ4whYXk65xdHA1377a23b2hOsNzWtBOyKomLBIS5Vp9M4wz64172sj/Nh/NFcxtMHi6pybJkq3G+kBihn9UJksday52WxMbVpU8EMm3UF1Rxkb7IaoQ78Z7HxX1XUEgG2vuUFO0laLbC6x6sdM047kGapZdLGcK+r1w5PEv1W4gxfk3Cw/rGu0GJUWLcsn27HOtqm+uwoFm83sn78Rey92955uPxdHaapuxHEQRhpv2/Xil0t1/OObt2Jwar9b44nb299gnsL284T5CvQKOV/R4kSGxrKRrzrdTsOK4VUPe3anPXdmffXf0sb049iS4Qrh6OKSAv2dOFoWjVMXAaEnuFKEAGNXDzDPb7v9pR5vU3sBTnIMnok5TOFcjkGgvwrJw5LBiObYoMGpRWuEcJdgx4vZ9lBS1MWospC61loSgFwPSsKK+QZOpaWX6+KptDjxY5uj4wXFFpNszmmMVag0NI4ZhBri+pZWp4ap3ShdDtkZ2yUXipxql771B7u8sle+BuZjGjjTlNKkZrtttuOJnxlav3AXG5h/1xB67ngLzaHSvFWf4SZ7hgWvFqvgRHXwRXy08H3sHMKXP/JN2+BF/+ljR9wCcpJd6hXGotc8n2dDg2LhGBtgm9Ezaos3HXFm5NKW47gJ6O/JJVWw8Rt5T/jBqolLdB2CC0hxoxxWpJrMf92OJl30VVUGq7cVCsM84+uLx5f+Zqhq01rYHiL6/oRG+EfMDij8nCMnB5aZ9w4iH4VVuBWdVtv8GxX7V0uW2GJInUuD6UHKQ5W7Q2iDou15fcKdzcrU0OJCLGNlO6Q1FplLM0CxhTF9pmGHst+WBwbrJHcDgV0vjE4G4zTBQ6dWiuJWRZaapM3JYSiedfn93//+HyQXd1v8v1TXt6UuMLV+feoyLhtUP/oQJeOGRsrhF1O1bt+BDXnMHsKGxIvwCypNDlEli1fzjNzWpQ1G8J/mQNtlzM+xSLEBBWgfrJmyW0m6m0KHFtM4ihR1Mhu7cnbyUofzHWdZHuEBT009BuGUZ7ine+Tudz165cR2e7qbrIsEHvxys9cVS/h3sw9/9z/RHnjqwmzcpWdPVLqlc576/OsB5lduyi/lUTt7u7td/LePf5/tojM/jhO1Xpm+ourVWNDdYqJSxScdea0A4ba9OB0lC1I/BkM6Wi8t0RUQTSyozf4O6rVU5Q+u4lfPy7Eb7zl1ovI8y5tmwPIJNog0J25O8THezRSPCXOkwJhOmgAljRqOzke7jrU3z4k/xl2nPAFdhsMLGkrMlNbIe5tNz8vxMk4a00S2kbpj6i+V4sgrn6nNojoC2qV+6NgBy5jRSRcG7Yi02dsu9nrGgNsb0om079xsdLa7rnBy+rFU9aatJJz95YY95y+DRnO7QrQNn0qHLKmoAKNDuMrKD4tZg16fso7a1W1M4Q6UZ5bY1CAjVSzDtk+sJA8ggqeMxOXzS2y1vbkcDUSqFJ5YyeMHyXSa3dTRah1lZSvieSrnepo9MN15nM3XtX8Kk97F2rS9tewJqLTBxdUGa6/1p6WTcUWvZfOGv9omu+o2Sdcm7nXtutZFv5XV7zBt6Vdq66iyKd5K107ZLFOr5VYKic1VjraCaaMD0q0eHuadyFWx1PUOFtdOUuvqaGpfQD4MrBRtbbBHLjbxIMgC9VGflXfVTArvqUOD3XJSYcCq/jmrromibERACDNwDfstdroWYOPN3gmLZAfLFk9/7P1ndnCE9T6DI9B45iTqNjojl4+AdDM8hQn44vqxX1dAtgdBBtTAdoyp1Ge5uoqzYMfEemeVe+Zy9W908qkZoTYFOXU8y2t1U9x/hhSPkamObiLxbtORDXSm7/rg99ge9tuys3ODo345c2zP5XVt9Y6l7dG2rhlR2aNR8QjdprNW6QRiCh8XQ817MoKNDW/tzg23ZXWM54y4g4vNhKDhxWLOp0Mhqw0q7T+8vfU3lWce9mYQt9nddFQNF3HCiDFw9cCfprgTZ64+UDrg1P0XFRtnSXCnCTc9/CuY+4fvy4ycPa/twZNucrxaoFwOKlxuTkd7DOzXHn3mA/aMjmypdvrdAZj1p5IF872oOhPMdi3MUVu4RiKWGNQ2vTWdBRMYtRW6hzej1RO2Rv6w4VBFtdCsURDMMURAYRzy4I7H3fgIURRiHKBacPNp3ZaK8ummtXaLdECNfpvETuVWqh8lFrRxe6U7hKFj0ip1EgZ7UzAc4LOTaKsatbKaBJAp5/GRSFSrj+2J3+SVR03E3fsXJu671Ha3sDsckObZvzzfuSNFF0lk+Mg/JHATm+aTFCN8BQ4udcD+8qVzRMeiwUc6XvlHOjMOVSNdQSLJCR567vKbfFx6eTjT8ROYwLY4IVUBnWmGJ61P6Ihy3mfc2bl6ao9lM4KyzYKyw1nOHR39el3s+KjsTJ3yYxo0Hb5+omaZIRFGDjl4A51pUcz14c5OBL9tY4IxhqA8LXpx1qkfYHjm6vptw6wbATTvhJJazY9r/rkKyKdyHTgOI6azq1Gm3vhCy6lngQ2rVzvsgXyV1gbkquBA20EwzsAeMWjTvWDmxvGNTYoNGEYxEFvAjcruxYkTosFcjtSTLu+jC4c9FObBP+IBdUgOPALwT5y/9fnuS4dPLrT5k87PHy7quHmnGtoOEAKPRzIwY6I0tPOOgto0MpvJOk4d4LpR+iBOx5nVPRBmk06YAZ4o03wgzH+W61kem/1TeSlkBJ+HKti4h2wBWvsbkGP8O3MZkGDXZPUENb/80Lf7ebbekKT2n5Cbdcej12zdQpvjZ6mokeIz2tjE38y2AzwBBHcydSkPxQfkkEAvnXH0dwZy5zOIRxpJUFTbhC+1TI2pYYZ9RqY0QYttCe+PxRYe8dAV/dOLl+L8BEtKcJVnK3tsnonZSTbamZ28qm8hJJ0INkSZnYFWmIB3ga77vd3a0l1fX/ck/dwDlHfMs3rnVf/49PX56TY+c1umFsrlRGLZpLbnvPGRNp393f2D3tPeHiUtMl3MZOrBQ/n1QLeXCjEKTY0zj99em/PttTnfXpvz7bU5X+G1OcYc4lnKO/NExlQPJ7X4xTh1EKriy3HYraMMse/YdWzvIBrbiHvrfWjRLzX67BMmwbH36JfOly+Yi3yXJ7e3eJkPJCe3D6R1mLQdSe6rwMd9H08jWbAw4r2Whx6HC+wsbgz4XV+uswIUm8e9JyTfXrbT/rKdFVQvqzsPIvs/7XU2K1BbVQp7KLKP8EKbFZhUSlMPhv6rv9JmBexeHe3BcJemb6OX2qyAyn+3zT3B2uA9N6vkzr7u5r6zP/RNN6tg815481XW7PfxQpoVFKm8mufeHPM7fCHNSqpUiwaPTJd/7NtoVmDeWB15dOy/vZnmd/hmmhVcVL7JqGSdT/glj7lRDhPcNoF6t4Di2ztuvr3j5ts7br694+Yf+I6bFYqu9qabwFTyPUe0KN5vtaLprV+p++kUCyxyEZwIzDyF1/kD6kz7U7r0xq4WoRgE/D8C1PjIH1GOgFP/5G7nX1ofcGUbG8MBAre3t/8H+u8r9Q==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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: eJztPGtT28iWf6XLXzapxcaASQh769YyQGbIMIEJhOxWQuG21LY7yJJGLRk8FP/9nnO6W2q9bEOSu1s18yXBkvr0efV59el+6PhCeYmMUxmFnf3OqVSpYulUsDgRSoQpxxcsEV6U+Iq9uNp5yWRIH9zxIBApi8b0axoFvkh67H+jjHk8ZGMZpCKhV3bwaMEUwMsU46GPvzhTgifelMGXsw16qgAijlFRAqATAnlZTIaPVRXoMIt9ngr/IB32voRfwqGGOmQznnpTAdOxmCc5pl4ifCBM8oCli1hs0MPh3EuH5k8/8vDFkBDCJ75UccAXLOQzYaHMRSLHEtE7SZkfwSxhlLIgim4ZT+sMlDQlDlA9NkQyzpC4IUv5LYwdcuUNgV6YHMQx/C+XwZnCD+g5G8MnAqZesAi+SNicB5kgoh0m5dgkIs2SEMjXzAKggBpnvoCvgJBYJFa6s2gufIDT2ejkj0980AcvCsdyglpxJCcy5cEnmuMsFvD+injg0ddXOzAW2AwsAmmqzv7nh4pqvc9mI0AZ+Gdll0ZM3cqYqIr5RIYEqccOWCgm8PdcIEuyMBHc56NAaHLZGFAAwXPvFiEM+8MeTC1xij8yYA38QEHBz2g8Bn2C34n4I5Mg9s4+jFVio6NAL2a8s//QQUnDpzJMxUQk8K0vxjwL0s5+f6Mzk6GcZTP4+/Fx48GCDeRMptUpy7T+xu9xIAubaDZiAT4j1aL3XAS3NFblmS+KFYVzmWUIqghDcLW0sEovmbUwUWkiw0mnae580ZJI9TJFWoVfWBDQdBH6AAFli+P1r5dtQszXylOQ2+iIEOX2mTCEnzBr59rhnX7eQMPbwm41WkCwN4EcC2/hgT5qc9aKOb19Htru3DexZhEuMPcxLACAed1AxBn9wYMe+xhKwMoxP9Z+KTBuo+gehDDhoVSaSFAYsDZGeFIxRFyotMc+TUXIFmDaYXZfv5vCohSJNplKJHPpgbSzUFvnwrYYZwF2JBX3uQ1GDvmNOGxoKyUV+IMJl6FKa84GXjdij+YazZ47bgZ/VjyVO6bHTgUHM0MejAhiUZZaPlQA5HY2JxdGKJcbLAqDBbuzzOIZQAC+g4UECmQ6BeM7goUGH3LPEwqtwa0IHfY2jAjZwfkJuxWLMqu132iV5DiJZvTWDCbmyEkYJaKEMXjXCMVm5unipx5Qi3LjLQIaSeMX8WNgVSsSRMDw/OMl25xvb2pXssl9sKqbPJYwevMB/v9VLE78x00DoQsQhgzlB/hpd/4/3YtspEVw4sM7TbYvYDEgn3zHL7t0OcxC7ZNhJsj8Iutj0LAUKAFZI3g99VkyQfh3MDmT40LdR+BrDVhV6EATwbMM1E7cg7fc0H+PRBCBpYNZAVpSV1fzERITRAtwwewgBId3G0Z3bsyAsVFlDTcLxy4eWgcWqI6syhDoO42dZgoEOeOxSOCDCpagCzPQNb2K8deYy0CL9pfLy3M26PdzA6iZVFjAMmuf5F3AFN7zWRzgs1d7e2/EFh94u6Pt8U6/39/iO/7rrX7n8RpBqjgKIUZCINv9Pv5H1iZM8U8ex4EJUTa/KrSOD/VJo9FX4aVkX9FypVJDc62t8zVPEl53+edN3iIKjRckOwqqSg6fdJOgoKjELE6N0XAsHcbTKEYLiniciplqQnslJstj9ss8nmZpAl4F8RaMYrwjcgY60KMQrAT8hf5mcHX+kh2A6YoS+ad+80FTrPWsmItNonQjj6tLDrb6Jb6hIM8sOeDU1Q5TUx6j4RExxMTz+BLtJwTqmFJojm5AjuCSirkIreIZmD6cJCTi2ijSZg80EF5UKdJ6Vo22dYSjTFhuFGiRmyOta6gI+gOgwRCY+0gMePNxxIYpJ9HrcHeRawOSpbXFBMIgGon5EKjDPht+6Xzp6BQBSKBltIHRsXmiQ1F4QivPPh1FUSC4NkbDMAsC8wK4RMrF9A9irc4PyktE+k1RTFkfT2AxJhCN5LpYC0ZcRUBFd5f+9tZoMOqPd0db3jYs+4HYHb/ir9FAuKNO1sCjJRYCIcUVFWhfKh8pLIAhri2NKBJw0tINSm1Eg5pvIEPhpcnBiiFlsnfG2/y1t7XXfTMaiO7A7/Punvdq3N0SYAL5G3/gvd6psuD43gPtnoh1WHFSE8HcyeXAhWlQNpUtJbuBDG9VA99MJFACBB+lEWi9kXw1dy7RvCfeeH3+ZtDdGb32u4Pxttd9429tdbfHu7wP0t/zdwTSHFHueeY4qedR7OuENs+ayVvO0OroNWiWXJVMKy7E5JtxqPtucPyqXf+qMofAaCaVKvunddxCMTBf6Hqio5O3ZYto1YqpWHi5ZEkTZjxWlZKKKiNslcL4feSuqmkBGtSjw99PbWRHQTTlUmiLZqZsAQvz54SHaU9G+VBaY8rEN4xgNBttcANJIqkswlr4UHUc1q4bqziF2IhMo8q8KZVUTGp0YIxxoSdOFoB2NEsVGAsH51RCFEWYI9Kt/IZcVYaSmN1geIu3N2vZ4KU215nL+mF0XYWOjLNgLANF+mcBR8kNKIDGxZ3qKH/PfuMxgzmQ8z12zIFx+GvBJnJukpc4UnpawAr9chEpOWU6Y5FbfDZakUpk1hoolXmI2sXT1cw7LFDRQywPdYHRxXVDl+i0UWPDr3fpzdy7wcBzCK7X9/5T+V14qGt9MxXdzPzIGxJfnyfGkzCGJMbheSE/zWs0LmqMEiDjwdPp6mneXZy9P4cvgRBUE5XrRRxJXMFmVa8tIpPnWgRuQhLxapP13gbNgEqhdsRi1+RIWmginEM+Ewsjo7IkOHv36VJHd1fn+Hfv+2tDWFXc/0/KYJD7P9AJK5celtucDPCz5ThRa9C4XvebdRjUHvC1+IA6imUzWzN+hMc1jDGpSEOWWLVFRYJbRnbp0lFFemR3QihQicqe1EksdfiCJlWLnDQRLbC7/WFhNuduXN2CxsDAxoQ1AxhBJWHz61tHpGGmEvp96p1Vxp1WyrGNDm5JUL//JdzqsWETBsN9otwQSMUaBYG7lxbWHwvZri3Sm1gm8m+XaTUC2q5iQMSa+UsiXwLW5tV5qKFLXSBEmeoYooi2GxmOiqzHuqvL5Ii15TVMkwwSybxyUZ+2JgaLIXhNKjOUI0Ew9EphEcwUJATuAOUMzfNlYHJwxxfKbqSYjLYo+ZEypiZ419FZwFNMfiu4mizlToymuHGXiNjZX8Qdk1rAfcUD6ct0scZCz30a932p6/HnjsNB5tWNAIK3eQYi0LhujTKXlpkbXhXVAgPE1vzlJIQVkhj+64IymHMJY+hJLp9EzCPDHHrxZJFQ0PzDJDKPjY26AOrFakdAn5l5DS+aTV5tc7eh0OPQQFXQJmgm66CMopJDU0WKTAc9Tu+ichq86+9B6vtm1PW2+QDS4D6kwRwS4i1ve7TDB/6ueDVGHniBBGmvk3Ye0pcNZZccpWK3oIkr1Ujq44cTKgtB7nJE4gDNBH/ppR8TuRqbD+ZjArN84hL7IVMwitDCbDKqIBqAa7AiIGsipeVPpC1RkBJGE2EQguwoaFEoQ6BGq8FUksWz+q2HjLBcQqV4TxhCNIUfns3muhLm+7LGlrTUOivux1gVN7c3lPGx3TUtSEsi3ONqcAM1q3qUR1mrCVsnYa4q+AZViNESgfmUiBJGs6ZICqazXIF3qwuprStQPQLNlYSF+8xCRQ8Yy32M/P8Ifsdhw3yf3LHuaF29gMtZqWpCPAsj0Il1MpQFRKiThMeALaNBT1ppWdlSGxX5VSzYT1Jv3WMyBeLHOnzdyY/hx1S7kgh4HMVoxgO+KNu5Pwfe1ekH9ceb+Nf7/vvJ76+Pd6bvJq6+XxKRq4g9Q4LYdq/PktwSwIAVy/gE1oPANhInKryjVWIKt7Tz4ASo8/iGInEK+fM/fYH7izd2ZkoFClE+ryZYd/QGv+oOiTeN3M362grTHuI3kXIIKRq3uypNK+bLJ7qHspGYRndGeWSoczcn4DWIj8RYb8bkT3gM1iKvCVWKO+U0XVP1njYYV9qKZY1byKIgmkRrmdOPH04tABzTAsyrbhW2QDu1wRW6Ud/HdLoRogc8SZ6KHw1icsYnzTSXBq7kYPGrAVglWXZEU7DW4YtDUHme64o/WLnZeuhkXPmyaEuLKBz+thx27ZLi8+o25GGcda99SlG8cV4VpRv2loKwxI00murNumGGis7UStjoPDfMmlXNdaQidtR6+aNMXH23Iy07gadWVQ7LzZ7V4gBEAp92Dl3NKQaU7FqAbUL5dpDd4810fqZ7Mb1qXVBVeHWRaZ15UorYYNK8IMIQhmIEpXtBKuQckoP2vjcpc2+N8mgjL9mlcckuqifHl2/ZxVEXcQWUvzu6po93DSMXeZne+GvC8uKMbe31t3a6u2wGX35/PLUgf6xaFGwGbH4EGRVXQMXSkpmgqm0KgbHiHsX8JiYp03FZfMAoFlmVmnLVELNLE5TkO3Mh4hkEi7yXAfkz4kq8GmRJYBIB4yPcap+JSzQ7CB8ndqnlReWCjI71KxQfCS/yhT+kOBNiJRpHgEshkjZ9jUN/UOXJQGdpRQCN0R2QabaNVSW0o+YRYhroFS1CgHEwSQRlMd+o48gmbmGtjEohxC/2GbEf2oQKE4xBQpPgNHU96GBOTAAj6R+kqVC1qKQtrsNB7FwkCsBZt2ega+wLaEtrTeSoJWUjujBHgSdB167YdhhVQ9A61udRvBpxYD1uwI6xyqLM5o5NTb+JKBepq+eXlm0zF/LCFBS+Ba1yHdqWnWnfTVksP8l0epmAEcDDD89HeRxl1ao87ULqbtgsoSWHpiaAacyyh58XunMV5DKX2FL5TQuHyGAGJLMwTbG4urGUUcXG1bulGkfYHoSQiybr1G6O2EzAavWpD4r6h+kIjoGsOcEJWhNiqi3bdfr9pb8PcOHJ/W7/DWUWt+sE5VjdqFdICcMmPNB8y0ljYaRo8fKwDrOsvKZ3eqs7h22FDt2PeRiFIdb14E8aWMOveWfwvNabMnTrLNRWPbSVjaGLWd3vPMd2G/cS80UQ8bwTbCkRPbfMfYF9lOvUvnSxGwBT5+UadSDamLCuuFikVhfQDisRjC1LzVkAR+Vs+fsm04ktxT4W0I1jhoxS3ige3vihsj+nXE31JrIZ8ySfc2UxdkZR+J/7x1L3Xl5nqVaEZxAUcXXrnNypd+KYuNqWL781ZNX9d24uT2DZKXjhDMsXLzAxfmlLrCv8vY63HGQ/X/ckRFpFCd6k1REbZTLQRtn9fliEhrRbVtrh6tlGsPYy8TqFaXuwgRrcQzIQ8Pjd3e238fI8GwXSI3NVc3WKml9+bYsvDBbLdlZykvMK6wwWM2qLNsgFIS5dwrcAjkPvCiNxdZHFuJ+3VhBbaxE42NreO/zpsPvLxfbuK3iOv38+/A3/ggf413Utqn336ZiZwwAOlowHEyAznc6aFoLevVb5QsjJWWbFC+AHFvYaLTWAHYpsxkPQdgpqc8xa/fJqedU2NMpiy4+H2tXuiq9g9/Hh0S/d4wtT0nY2FOi8jnWUTUTiOsH8v1lVVzhaWKaW0tzBOjWZTgM2b1sbt5Zj8rbUvYWzoQenk1alvi2IH7Bf6+vdre7UQqM9tLUdffDYmVz32Tf1It2zVM7QRM9ijAEVuETMHKsR44z7JuFs6Azfej143d/aetXvw/T5uefvOX3AFQbaaLj8ddBoSvwrnfmtfeotzdy1zuq8g8jpT6l1AThb4uUt6dJWcPN2aut2pN1zq+xKVWobtb2W5vyxNT9ryJHaU5FyzK3D2yKMrEVMzWFFs8VyNdpVL6rdFCe06VxVEJyN6ZR31WtBqkAbfOfF97U9nCzBk2bwhRvRuUecSyGd/prOTrFcvwtdxCwkgkjipOJB2uBd4sfO0WzyPIzPudTGwoG9vWuBI67PAY5IKyo1+XgIyJ4dz2fYwQSZHq6G/b6Csj1BXuIGGgaIKCESmcuo1HTXlrmeQOqCBynp1CNW+MR/KF08JAi1KajdSs/yXtyvkxu3zBDiieAqdKpOPT7W2vxQABBJpSAl5QSppo2h6ay2dsz3wsvw6aUspQ+5Htm2344fZVr6FYHCONde5n7Z9DVZb2VjSjKYNjJw6Or3+oPt6vEN+G+NA32HUeacm2g8lm4ZUj7cfEnbgTRY7wri+U0zZINiAEoHNSedE4tSC704qWc6K81tAnkEYeJb+GJW36ilZdOo1TnL4dGrweol1ESw2TfSZUfQJictyxfvoMruKU9KsefaKL1fjkzeB2b41NTKWfafexXUzk0H5r8bN9voWsLuVdWpa1E2MrOZjFobd2l3t+RLqku0aYUAuFpo39iZ17w6kDhzfhsYjKAGTzwn7JIikiRKDiGSRtTxb2ePHLuTl28QF6ObRJ2LYEABXg18U3qUd9T8xLGdC3du83tYOo+PLawrnTzDoFsfOtfFq4K1laPkzXamgb1bf2H2fgy5yctofZRZs/uX1rz8KLBxnjRNhUd4XgAMQkJd1hBfHtAVEfDnNV508hPdn4GJLz1BqvkErxvK60n6hqLibPrhS5jgF/ITyCRdfwZcJnQ1kD780tmc79gLKsy50K5eAZuYoUh/U/lf79JNd78IsxFNRtNtR0diFhkqMZROwBN2pmkaq/3NTR/edXkse3JiGgU79TtczpPIz/Q+XAuYVRDAdk4wo20ZrvTrKiLXBft1BkHKY4VQlG30g5aLH0qFiZrHyu8kKW47ycOVUpP2sARnaG9ZsbdmgK0fy3uwSvqiEY0jG7IXYLKE2VCAcJF4EHNPvNxgojfpVcDuMzPwH3hHB7IDb0H5p87wXXV76OjLW2y9ofPu02WdNudiF7OxpNHTkAzOGL6Uizc5B5UpdJvJOvmyRrnRPjs21lkbwnVLBhgLibJVusD234U8c5HkTak1RXB1qEJN0cka610jRVtXuOyBwxL/n+Xe1git+d4It8p7olTGsSn1xRkt0JOXFGg+8cIJwCiNvCigbXvwU6hVIsQxyrinP83ZBIjOJUwJ8SyGizqqpZW8yA+Bu0d4MkUak8JnHKKHLtErOW45B7j/TeI0nCZsTc/NC9AHULFyW4uerdpEsjk7Om3so8Bk0BPYSrqf3zd2ALoLfN3u9Wuiu7u763F63QOSN81YtXl6cnj8/uK4i2Mei5S8ECcyyzdtL3aRoiXTYt/ubw96O70t6tOOVDrjoYMPViFKO+fVReC4t78vFPzLXyhozBde/7UJVIO/eDRq/GC87+fOHG8P1P6XdtBcD2yqhFTlIi+cl7SsHwaXNY1wk/5z5+EBSy0fk+DxER/rG9nIO0OwCqahuHmoVWN/7D2FjdzADWvnukIaDg+0T18b8adeOrgEFVumeiYma1xCuGTy/C7C587+rdcQLsPNuY3wmeg984bBZUjlxfEco2v8kUi9+YGRsw3RnrYW/r5I8O+LBP++SPDviwT/jRcJLrFztesESxZYf3NAQnHe1corj24R4OdjTOF4VroBQ+sUPtd/OLtcPFw4sKtprkYB/0WEGof8A9cRaOo/88/1m9YBeWKov0Z+YDn0X8xJooY=
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 verifier global configuration
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-digital-wallet-open-id-verifier-global-configuration

---
id: config-list-digital-wallet-open-id-verifier-global-configuration
title: "List verifier global configuration"
description: "Lists the global configurations of the OpenID4VP verifier. The server sorts them by `updatedAt`, newest first."
sidebar_label: "List verifier global configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv2zgW/iuEX7YFfI/TSzAYbCbJdD3bbYMmaReYCca0RDlsJFJDUnE8gf/7nnNIWZJvSYvdfZm8JLJEHp7rdy58aMXCRkbmTmrVOmq9l9ZZ5m4Em6V6ylMWaZXIWWE4LrBMJ/TxYy7U+HT0+ZzdCSMTKUyXXcJ7Kwy8YFYbTyVj0wWbFHnMnYiP3aTNlJgL61gijXXd39Rv6lgxbWZcSUtHMKVNxtN0wW44HKfE6oStHPljGwSyAujf8DvBOItFnuqFiFksZ9LB5jmQFq7LxgmTjo5QcEabhArMc2Xnwlg2l+6G/ePy8pyN+n1gtdVu6Vz4Y8cx6Mozgho79dS/EHHSTfw5cP2OmD6p8wyEcm54Jhwc0zr69WHNBh+KbAp8gKqNiLSJQZOa2VuZs0QblvOZVEH2Y1DnDJ7vUAWsUEbwmE9T0BlPC8ES4MeyKY9ukcKkP+nC0RKP+KMQZgE/FHABP3WSWOHgtxF/FNIIkA72WtFu2QiMyFtHDy23yHGpVE7MhIG1sUh4kbrWUb/dyqSSWZHB83LZfijJpjKTbv3Ipqz/4ve4kaltMhvhCqMYKB2lFt3vZXDguWqe/JEeeNplV0oCc0zGQjnvacHLLVfxVN833Qv4KqwgU7gbaRlyBB7dZV9uhGILXYAfqdh/uwF7CFN5l4wEM4XyAbZyJiYVvQB/cuLelaejEuOtPCBB7pi0bcZnXCrwd9zgfdtvh89buYd34PGusS+Dx8bmZkB12XuB0YTvvUBMF67UwxoBCunLuriww9a1ATENwT0vlcULoAB6jwAhfMhxNhXcYCBGkbDoCLdC1dS7ZYdix+djdisWTVU7fivsbksmRmf0NWwm5cgZAJBocAwYo9Fs4ZwOLo1AWrQb32GgqSQfEEQXVLWTCRJgcn51yXp3w56HlB6PIaB6PJewu/cA//8pFuN42QsUOkBhwtB+wB9pfPLvzkUx9SYYx/DNiw3wB+GE2Eve5K1bl6umLPQ+qQpBkYeqz8HDHEgCtkby/uiPZob053A4k0nl7lMNYniytvKBbQITPIt7QM22f56KVKsZngrUzKa7hkUrLAfYU4B1t0rPVS1o22ieZgxvN04ZPBQHJdE2HdWkQOs8d14pkEWSRBhYsMYl+EIGvuajGH8lXKZrCaTEQa+kCnubqn0SxFlnpJq1lu2WuOdZnuK7V2/evBUDPooOp8PkoN/vD/hB/HrQby2vkaTNIXsLi0SG/T7+a6JhLXmnYBrhnXdv6rUoEmGWckiQ53mKQQmfel8tUn3YZF1Pv4oIc0JuEP+c9Dzd7cmWG7x+3stVQGYwRGHIVJQ6yNW5MXyBlhdZ7gIGraNdqAnWqgw0nhOZ3SZJk7l3W3jaVzWNoQrRaRxgSjiIQfQ2dD0BqxZhqddrmWy2wTSiMZmkqVkZbzrOOs+fKOVuSYBPKL2C02QBakG5vvYg5UrMQncBg31iJ4lD8HlQzMpyBRQ/2eMIgDsoXs3lXx0mw+mb6C0fxCMBHj/k04NRFGNg7KXzuEZ2lgSPaOSKMiKIV4cRTUmwzXwZjJVaLACnRV0rDcGmr+NBMuLDzpvoQHRG/O2g8zY5HHb68UH0Srzmg+noEIXUVGl+rDnBU2QbbwjVLI4DJmYYO+SHpX+CWGtRATzYIs+h2j8BwEKyPD1TkVnkZeQGVqZap4KrDV4oqU+cKcSk3dSvz0AWIVl4ioBJVQAdQxGgjfzTu/6ngG+rwgiwusQ8lumYMt8kBlSN3O+5hmrt69xN0BKTOPod8iv9bhgBeVpiMAnIb46O+eSD7+w+B0J2XJfPl68b4r2XiXDSJ14sHtaY9rEMVYQFJ1CxbUTU3ADiNEIqlBETcZ9PWJRymZUGXNWgtB/bJyTsd8H2g1f9vk9wviigsrj80JAaX4DUETgsNWyPiwiRcs9QRuuARk2YCl5XEBGLrV5UO3/wevS6Pxh4LlZt43+Ti5SDZqIbrmYi/gZulvW8/Cui6mMYsyM890fMIw5Xt0xdP9fAXlAQ5TgMzKpP3Ja0nHQENefVqvXMEfInrBA72qu6BU5q2ZatrFSpEjnUADLjtTS6i94lLq61hZR+Gb+Dwgo73Drt4WFJHHn9HuLINDbKFnwCIrPsW6uwgAP8y8dpf1hjuexeG9pA94ZC49yIO6kL+wSkHKuYOh4qu8GfjfgbolweKGwcQbWjP+UDNJXff4LClnSdOqHjcj0q9lVxDYe8pq2hXQDW8NfIl6VPLijrBwtjtDkBnEce8fm0Jtl1+5His9q9zbormUcEShvkt+TbKpP/xKGsUnmBGgwTn9bSK26z/m5UcwBMocdp76xRd0y32ixUwLvzeijAAFV0eieo/Fi3xuAvbI0rxUOqFvGGag7/8o4aUmmkizQOfsR9bUHoD9D3eONY1ymWkQLSjXQLGoce08ADHq9xbPcTTYOwdqI3qCU+w7lpK4xdmZ+7shdleXjyEg4ou0RUK8hzo3FkO6MpZ86RVqs2cAmR0vGR0sPMLeNeKUXPS9FpSoGpnBSxbYZ7KjId9ISZ2qTY+TuX26NeL4ZvHSw65cxw5bpStzbHk+dGx0VE0b6DzGMULhwC7mzXdus/rzNyXdniAl3Ye15pkZUL+ZnUrplGo9DdSDSrcVs1yFu1k75mDWXtpEFnUg4Qy4EQ5L5E3gP8+Rma55FN2AtwSd9cOQPlAukg55F42WaiO+uukT1iYeMPOH5CdeCA78cJdTd133to+bnkz3hBAXHf+uXL5aZstZklRIO1JXueUuAZC9RmM7DSIOEGpWna0FphAtqthaEiVaJLAOIRARAgjUTbhtLy75U9VyaR76pXTUeo+9CaNKtNwLe+g54WC4JII2aAhiX+z8pitTnkoCmMD0G6kKiqXcvG1hZcRQIClqJ1/JJ6k+0bz2v1cBXh5y+RI6cjnVLXBPkMvUoo3GNDsvwzDISgb5JwJHSH2Mn6RohCe7HKkFGNvcKSxzhYxk1sOySvBD2wJNXzcC8UNE3cfjk4YZ9P2AvwB3Cx8dnlz+zitAO/4K0/bXzxkQ3e9AcHnUOWneqol52+r52JVMClCBchkQjoWtGqZTCB74Jeh93+hunm83mX0+cuiNwLe23v/fjk7MPFWQf3LKtivzInKivWUbGynm9nrDf7sD8cdQ+6A2ojoFvOuKrxgxde+wF+PSpqyfL5gnHvBWOIdbwG6uXQ4Ss0Adn8IWQtqLKHfu4KPKKiG5krdJ2N9hQet+cvgPobsC7SfHjA5ufKpMslvvZ3dZTVQGgIqWoYvdOw/9tby62KucWUVF1e0nZ44XPhkxn/1ivIPayUjWPFyTX+MARlvp4pc+W3Kff5svL5svL5svL5svL/eFm5B+Y2riwbyOvXHJNRat82muRlvTF7d4a1NA+FdtVk3FKTER4QM8tPalGjvd5veBbwLzK0dcsPGEfgqT+ulvsvOzesKnS/GvWBY6z/AEzAKuE=
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 verifier global configuration</h1>

<MethodEndpoint method={"get"} path={"/v2/config/digital-wallet/openid/verifier/global-configurations"}></MethodEndpoint>



Lists the global configurations of the OpenID4VP verifier. The server sorts them by `updatedAt`, newest first.

An organisation normally has one verifier global configuration. The organisation must have a deployed digital wallet. If it has none, 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"}>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={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The server listed the verifier global configurations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary 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"}>verifierGlobalConfiguration</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Verifier global configurations for the current page. The array is empty when the organisation has 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={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 is not 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. Use this identifier to read, update or delete the record.","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><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  \"verifierGlobalConfiguration\": [\n    {\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  ],\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 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={"500"} value={"500"}><div>

The server could not read the page of verifier global configurations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} 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: eJztWv9v2zYW/1cI/9IWcGwnbXe9Yhgui9vNW9YYS9Ie0AtgWqJtLpKokVQcN/D/fu89UhIly0kW4HYYVqBoJJl8/LzvX6S7XixMpGVupcp6b3un0ljD7EqwNU8SYVmRSXrAbfg01+pGxkKzlGd8KcyAXRpBC34vhN6wnGueCis0bFVsIRO4ZPMNW6kEd40nY6boQSxuZCRYnnC7UDrtM57FuCUHqkBPq2K5IrpamCKxcNAF3Ci95Jk0HEGztDCWrfiN6AQY8ZzPZSLthomMzxMRD/6TIQ0jNB2tBRweCQMns5laLIywM8evNCwRhpjP2IiQcTZLZCqDFSNkhJatpXVQY7HggJXd8KQQAzZZ1HSRJNdLwEVEcXVWpHO4V4uSxT49ruHZQmdOJQkHTlEyg16/p3KhSQCTGPQWqWwhl6i9sVxKy5NPJIezXMDv7voSNAn7atX03n6+a6n/faUpPM9p65lhYxGJzGqeyC8iZpMYbuRCwsLnoMkXiEbibtI93GRwANy67WMZwyMTrUTKe2/venaT44/Gapkte9tt/34MLQNBObWs05nEdabWmRM5qFILNpPKzPpsBmrTSsYz0t8stJyZ21lKOlawM1OWAdTomk4hcn1mFBpHkQVngOFbWIcbGlj2iKKED0+0+L2QWoDSFjwx4h7R9Hvilqd5gs+Amd6uqD4EthMpHZO3mWuZMzgMLUVmxOmAHbNMLOH6Bp0HoGrBY/QGzw1ASQybc+Rbsdloto8RZ8iPYkNmVoClw1rvEL23o34vlZlMixSuSfWeLDlV+8gmr7/wW9zY8JeKZ+clDFyi8o8nATwcdRjkGV3wBIJcJgEck7UDeHM0YFxzddsMTICrgKiIqrAr8HxEJAzY66eVyNhGFWB6GO3wtxXoQ+iW6xfe7ytXZ9LFDPB2K25teToKMe7E0C/jFATWJZeZaURx2g4/d6JHd0FvCPelcNnY3AzFA3YqyjjsGGKqsKUcWgQgDLcDMUdl1tJgKks2bF0KixdAAeQecStcsOVsLsDVNeNRRIFaXYssEG/HjowdTyfsWmyaorb8Wpj9mlxoldKvfjMJRy4zpUUDMQQUhWrz5xzg0gi4Rb3xPQqaS7IBQXRBVHtBEAOz6eUFG94cDV3AH/IYHGrIcwm7h3fw92exmcTboadwABQg64D+AB9JfPbvg/Ni7lQwiSkjuTCbgzuBnGKyJqfdkK9AWGh9MsM4C3BR9DlYmAVOQNdI3h19ppdIfw2HM7mozX2ugA1H1tQ20MUwJXZxCzmt767nIlHZEk8FanrXXP0iZCZRG8j07LgO27XTYpHR8uFu5VRJHv2gJOpKlCYFWufQOaGwWC4WQsOCFkqwhRRszXkx3i24TJxqf7y4mLJXo1EVep2Q6tjbFO2TU8k3b978UxzyV9Hr+dHi5Wg0OuQv438cjnrbKyRpcpUZYZDI0WiEf5rR8KKjyHLhV8Q7hSPyQsEqs0iJ53mC3giUhr8ZJHe3i1nNfxMRVSoaA5+VDsy6LmLqtVxrvpsqLloomPJhs9CkEkoRZNIJGBcqWKQ5FIhgps10DsFPCxGUdq6SJbakFSkBg+VnC6ql2gxYaUnijfqrCfW4cZwWSwCkA+PrKmmxrjJNl+TJmm8MORgwc4MlOBhmEld+7DBhHeCeE/EVp/rFlQCSKmAnCGc2fSwE4D8yrhnWDbOsSBKqDZq6gRJvx+banO7mTpcYRUsCmNPLdgIwOXDcRalZbQQYW3IOaqnq2QGaeZRIoD95BJ4TWtmRyz0cDJo8i6D8AzoSfRXCftm5XP56ShipV/EkNuHuuMBD2dlk/OrjyYRCBtXicDtFTVoVKUwLgJtHiMgE8C918gh5/noKHU2cK5nZvdALhIhyjiFORFDaqjQFOTsXDE6cFnNwTMgdXX7I41i6CmgaaN1qKI17aBBYR5b3TYyOLGW2nz79fD9KECTYLYrRuQsWW5YdWwslk3MIOB0owL+pMhChTMmCNMeQ6JWWRoR6nyuVCJ7tCI7KgxnCnfWdjYUGiG7gqH3x2vU6qoOAxzf1/vjMlG7odMgBnMazLrAcebQhVttAVBcdbU6gzDPklx0NRizye+tCh8qwi9pzJKKLIEDDU6iwMFOjN3EGz8hueULWGSvKcmsNcQ3XAOeJWnZxdEHcPMQVriq5iNocukKNzA8xifjYdtbl2DJx6x5986orpNwyK1O0kDRnz6HKAl4VxMAXrmzc0e6aGx9kITnHhKDI4z8TgQtwBITa+VTFGH0cljq8jantnZZt44PiHv/f22TMCu1+NWBogiIF49o80is8Q7Lc5myGmQJLCPCD+WYnd/iYGybRPvmLh0VVeZ77mIJhHOS7YZPmES1FUD39MNzJThqJ9Ca3aql5vvIhsJ3Qg5SP1khQeR3vWkB+ERZadttZKT09Qh9XO1nqD+jGWQm+Q8oDHOME1ejnHs18qlwc5rXdjNMK4DsBtDP+hJEj9OF7fOgea9xVeKfkr3A2cH+VapXlyYkqMnu2OKki7I8gKqU3T4kw9YhnX1qUxhSYR+t5SN2NuIayGYIajvqyrbn7GbjaXuGGerK02x9McXIbg8hkYqoSz402IYbQ6fvq5GlNti1XX7oj8T0TnEZKDQp9PzAKmT4EFojPSVnDP0DvAhcHkyeq/Rm/AR7JtQLaR69L4oj1KcQRNM7iMNuDesvRWKCyvp+XPUz7QwtyOSBrSGMEBKEVmGrwF1WYR5RQkyymoQp19qBfLZ5hSZF7CjtHUAfhTvkgbu3TT8hw6tWmjnFtu20b8jpsugKDvaKVfgABSPDulWt0H92phucIrZU+UTFBwutxwMjVrrE37bre3aXMikUAuO0g35GW6hT8PY8hfeaFrVuk3tbJabddbkwp/MSDtztP9N224A7/xoK7zOpWYUc0r//WNoUJVmNVgWUjBB06piUj2ATFcoFpmMYnxzS9hEvKs9/TaBcLA3qCXPMlvrPq+TdcZUJ8XjbWJy/ggFZzhtICmCuFL8mWwsUCJNkLhqixI3jgzH0IssxkPHR3B6Xxl/c0UcI3WsRY10u0sUiV5xtrE2zmeytrc/N2OIzhtwOey4GEyjCzA6k6XusA+LigqcA+Mg9ROLcY8Jb7thv3cxvIVa2Qc7RLZ06lWuqhm3uwZ0rpS7kvZR5v1ZvlAH2nYy1fRfnyedagMytfCZQjXkg1C3kLGdJNxR1GNmPPIXC56SrUpjIhGeQ8Ei/6TAyWgxbZt8xv/BYHyigOHNl/N6PSOzTAu5570/C+LNagR9/lLXgLAf5hTAnPUfKY8V1AAwSrJEjBgLIibagrJdQb1dgyW6gyqvCIogqED4m6xQJdafuvWp+VSuQP9aOmIYQ21OKm2lSGfxoaKAwEOCHAvylo0LHgleY8kaq+jzjLkfSKsS4jDZuUxepzPxp7EczG2huhIjHVEZWbT19UAzTjRx1oVe7tvvGZzImWhvFYH4s+TU3d7N6PmbzXB4MQwwpDFmNhGYdS+oD4lSAHtkjU2g+CvaQJ7aeXJ+zjCXsO9gAmNnl38Z6djw9wgvPxxJ02OT9jh29Ghy8PXrN0rKJhOj4Nhy+u/qeRMmQHkRkK26Uzge2CXI8Gox3VrdfrAaefB8Dy0O81w9PJybsP5+8OcM+2rq1rdaKwYhUVlfaANEYyp/aj0dGrwcvBIe7NlbEpzwI8+IFBY7TedoIg4X39luQv8y2JDzP4TnkIHEBc33pzu/Pp8nPv5si9y4GEiUpvpEz3OUom6765Spv1E2cvkGNWYFZI8e4Om5xLnWy3+Ni99qd0CupA6Vbvtfaa2JO/V+nk+BrTXOOzFRI7PHMp9omw/nqfsNwjneBLlicK53/70co90KtvV54I/I9+gXIPlLKpr5Fc4Y2WblKHFXBZWP0xh/j6rcrXb1W+fqvy9VuVP/FblXvC3M4XK43I69Yck1KC33bGJNuwh//hHTZe3HdldUd6TR2pvwg+xuDZJqDdbk4dBPw/GO03t3yLfgSW+l213P2yd0PVzrnVKA+cOf4X4cMOhw==
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><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":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></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 organisation admins
Source: https://docs.igrant.io/docs/openid4vc-api/config-list-organisation-admins

---
id: config-list-organisation-admins
title: "List organisation admins"
description: "Lists the admins of the organisation, with pages. Use the `search` parameter to filter the admins by name or email address. The dashboard uses this operation for the table on the Manage Team page."
sidebar_label: "List organisation admins"
hide_title: true
hide_table_of_contents: true
api: eJzlWFtv2zYU/iuEXtYAju0kLTAERbE0TjtvaRosTvNQBDAt0TYbiVRJyolr+L/vHJK624nrYS/bky2J5zsXnstHroKI6VDx1HApgtPgkmujiZkzQqOEC03k1D5JNaOCa4rLOuSRmzlJ6YzpLrnVzK4Ya0ZVOB/De0UTZpgiRpIpj+2/EnCyJAK+AyJhCeUxvI8U04A0gkUR1fOJpCoimWZoCAcTUqasYjKVDsrQSQwIwj58ogIsISNGE2tTN+gEhcgwAqdCKaZ8hq59rrhxZu2BxYXBOjj9umoE5CpLJuAAhEGxUKpIo1f6gafWGNDHhUXrkjMi2Az+L6xvmVCMRtbOBY0zRqY0jsF7Gj4gwrg/Rjs5qvieMbWEBwwLPMrpVDMDz4p9z7hi4AHIatYJdDiHkAWnq8AsU1zKhWEzpmBtxKY0i01w2u8E4BZPsgT+r9edVQ4b84Sbpsq6r5/oEwoSsclnxUymBIHAFlHey8AjZ1Vd843NHQJ7kFSyBtICRDBltoTKpdxOlmijuJgF6/U9rtapFJBf+P2438efuj2jZwsAfYecMkwYFKVpGvPQful90yi/auuXk28srO/q18CpCMCkVGHKGu5s8u9LaaoUbe/Xy1ZywxK9yYoN+l4ylkfwwpZsvgEAM5cCf5WM2TDyf67cN5qBRcL4yOBiJiLYg6FYcOPetRwHHa0ta3p9KzikAeERgk855EneFpwb69zKDUiwMqGwaYUfdWjbEn7R9caEgC7fXrLsQxbHvrlN6wa5OL0IkOu3y30ZojhPoOKG/zw2AG2hCsxbtTFMDdC/LrEoN6KwJyhUQeNdjLvwa5/dOvfNLK+VXMB/tQvw0MuQ1AuR4QCxfFZubkeNJs8UD0Gs2Dmt+UywiCBGjnW1Uxb8niVUHBbdv5oPOVijNDYUXh3y3A6wrDIF6wgExtdcRrpV2Cn48QgdfB8VuSxpF3JNBxPoZ1XFRIKfFLYTOn0geRRee6gYy2kPU6ry5FLCzHUU5OJ2MCR3MFhZu6dtN6up724O0WMbtQD78DhFpgIvsTUZc/HwU/C5MJlTTZw0vuOq6sYWdxtJI9U5NGV8oPHFUzinYrf2UEqRXKyS81zrDGziHxUVpsslOatqJGEhjBuLW9tu6C9HYwgigAfcjld6JKFhKDNhbGwo8cCEl8iYSXa4/Sh43f7NsIrURN6tyK8qVV1Hy2NTMMNNCQ/dKsYX1+WqZv6GmVJg+DU22pc72LlbbalZPjiwO9MkRUVHYJGRBvp0gxBswxvh4goRtESC0AXMRSyHKvbxmxwcbd0H3J4kgBpryD6o+JypFhpObLnhy51aec3knK/WotEHQMi0a8UWXGZ6j7RV7BebqB6hpcLSUKflCmbk/hoESLfQjcrYep2n