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