Guides
API Integration

REST API Integration Guide for Backend Systems

Learn how to validate consent in real-time before processing personal data using our low-latency validation APIs.

1 MIN READ

July 2, 2026

Table of Contents

Authentication All backend API requests to ConveyGrid must be authenticated using an API Key and a Client Secret. You can generate these credentials from the Developers > API Keys section of the Admin Console. Include the API Key in the x-api-key header of your requests.

Validating Consent Status Before your backend systems process personal data, they must verify that valid consent exists for the specific purpose. Endpoint: GET /v1/consent/validate Parameters:

user_id: The unique identifier of the Data Principal.
purpose_id: The ID of the purpose you intend to process data for.

Example Request:

curl -X GET "https://api.conveyGrid.com/v1/consent/validate?user_id=usr_987&purpose_id=pur_checkout"
  -H "x-api-key: YOUR_API_KEY"

Example Response:

{
  "valid": true,
  "artefact_id": "art_555xxx",
  "granted_at": "2024-06-15T10:30:00Z"
}

Need help implementing this?

Our integration experts are available to guide you through the process and ensure a seamless setup.