SyncNexaSyncNexa
Docs
v1.0 (Latest)

Consent API

v1.0

Manage and inspect explicit, revocable student consent records and permission scopes.

Last updated: August 2026

SyncNexa treats student privacy and data sovereignty as fundamental rights. The Consent API provides an auditable, cryptographic record of permissions granted by students to your application.

Every time a student verifies their status with an application, a digital consent record is created with an explicit expiration date and defined scope. Students can view and revoke active consents at any time directly from their SyncID mobile app.

GET/consent/v1/records/:consentId
Bearer Auth

Get Consent Record

Retrieves the current status, granted scopes, and expiration timestamp of a student consent grant.

consent-record.jsonjson
1{
2 "success": true,
3 "data": {
4 "consentId": "cns_8f7e6d5c4b3a",
5 "appId": "app_8a7b6c5d4e3f",
6 "status": "active",
7 "scopes": ["student_status", "university_domain"],
8 "grantedAt": "2026-08-20T11:00:00.000Z",
9 "expiresAt": "2027-06-30T23:59:59.000Z"
10 }
11}

When a student revokes consent, SyncNexa automatically dispatches a consent.denied or student.revoked webhook to all subscribed applications, allowing your backend to promptly terminate student discounts or access privileges.

Was this page helpful?