What compliance does

<aside>

Run real-time, compliance checks on one or more contacts to confirm if they have completed certain Lessons or submitted certain Forms.

</aside>

Compliance measures how much required work a contact has finished. It can combine:

• Lessons matched by tags (with optional “released only” behavior)
• Form submissions that have a due date and are due now or overdue

For each contact, the API returns a single score:

• compliance = (completed lessons + completed submissions in scope) ÷ (lessons in scope + submissions in scope), rounded to two decimals
• compliant is true only when that ratio is 1.0

If there is nothing in scope for a contact, the score is 1.0.

Authentication

Use your ConveYour app key and API token on every request (same pattern as other ConveYour APIs):

• Header x-conveyour-appkey: your app key
• Header x-conveyour-token: your token

Bruno folder defaults apply these headers for all requests in compliance.

Base URL is your environment host (e.g. https://your-subdomain.conveyour.com). Paths below are relative to that host.

Endpoints overview

Config endpoints require an admin capability (“Manage Compliance”). The run endpoint is intended for trusted integrations with the same level of access.

Run a compliance check — POST /api/compliance