Consent Management APIs
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 [email protected].
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.
Copy the Data Agreement ID from the response for performing other operations.
Request
Response
API Reference: Create Data Agreement
Step 03: Read Data Agreement
Retrieve a specific data agreement using its ID:
Path Parameter
Response
API Reference: Read Data Agreement
Step 04: Update Data Agreement
Update an existing data agreement using the PUT method with a similar request body as the CREATE operation:
Path Parameter
Request
Response
API Reference: Update Data Agreement
Step 05: Delete Data Agreement
Delete a data agreement using its ID:
Path Parameter
Response
API Reference: Delete Data Agreement
Step 06: List Data Agreements
Retrieve all data agreements:
Response
API Reference: List Data Agreements
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:
Both name and email are optional fields. This allows for anonymous onboarding of individuals, with details being updated subsequently if collected.
Request
Response
API Reference: Create Individual
Read Individual
Retrieve a specific individual's information:
Path Parameter
Response
API Reference: Read Individual
Update Individual
Update an existing individual's information:
Path Parameter
Request
Response
API Reference: Update Individual
List Individuals
Retrieve all individuals:
Response
API Reference: 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
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.