Documentation Index
Fetch the complete documentation index at: https://docs.responsibleailabs.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview: Compliance API | Credits: 0.1 per call (up to 50 events)
/evaluate and /require decisions.
Parameters
Links events to a compliance session. When provided, events automatically update session state.
1-50 events per call.
Event type from the taxonomy below.
ISO-8601 timestamp. Defaults to server time if omitted.
Event-specific payload. Include
user_id, purpose, and any relevant identifiers.Event type taxonomy
| Category | Event Types |
|---|---|
| Consent/Notice | notice.shown, consent.granted, consent.refused, consent.withdrawn |
| Decisions | decision.made, explanation.shown, appeal.opened, appeal.resolved |
| DSR | dsr.received, dsr.acknowledged, dsr.responded, dsr.escalated |
| Data Lifecycle | data.collected, data.shared, data.transferred, retention.started, erasure.executed, breach.detected |
| Children | child.detected, child.parental_consent, child.tracking_attempted, child.aged_out |
| Model | model.deployed, model.retrained |
| Aggregate | aggregate.fairness_metrics, aggregate.decision_stats |
Session state side effects
Events automatically update session state when asession_id is provided:
| Event Type | State Change |
|---|---|
consent.granted | Sets purpose consent to “active”; adds consent_obtained to fulfilled obligations |
consent.withdrawn | Sets purpose consent to “withdrawn” |
notice.shown | Sets notice_shown = true; adds notice_shown to fulfilled obligations |
child.detected | Sets child_session = true |
child.parental_consent | Adds parental_consent_obtained to fulfilled obligations |
decision.made | Adds decision_communicated to fulfilled obligations |
explanation.shown | Adds explanation_shown to fulfilled obligations |
Timer auto-creation
Some events automatically start compliance timers with regulatory deadlines:| Event | Timer Type | Deadline |
|---|---|---|
dsr.received | dsr_sla | 90 days (Rule 14(3)) |
breach.detected | certin_notification | 6 hours (CERT-In Directions 2022) |
breach.detected | dpbi_initial_intimation | Immediate |
breach.detected | dpbi_detailed_report | 72 hours (Rule 7) |
retention.started | pre_erasure_notice | retention_days - 2 |
retention.started | erasure_execution | retention_days |
Request
Response
Number of events successfully recorded.
Number of events that failed validation.
Per-event results. Each includes
event_id, type, status ("recorded" or "rejected"), timers_started (timer IDs created by this event), and state_changes (session fields updated).