canonical: https://jentic.com/apis/clearpolicy.app/clearpolicy

# Clearpolicy App ClearPolicy API

The ClearPolicy API manages an organization's people, groups, and policy documents and sends attestation requests asking people to acknowledge a document. It lists and adds people, moves them in and out of groups, and lists the documents available to attest. Tokens are organization-scoped, and the current-user endpoint reports the token's role so an integration knows which operations it may call.

## For AI agents

Send policy attestation requests, manage people and groups, and list the documents in an organization. Reads the current user and token role so an agent knows which operations it may call.

## Scope

Does not handle payroll, time off, or e-signature capture. Use for policy attestation requests and people and group management only.

## Capabilities

- Send attestation requests asking people to acknowledge a document
- List people in your organization and add a new person
- Add people to a group or remove a person from one
- List the documents available for attestation
- List groups and look up an individual person
- Read the current user and the token's role

## Use cases

### Agent-Driven Policy Attestation Rollout

An AI agent connected to the ClearPolicy API can roll out a policy for sign-off. It lists the documents available to attest, lists the people who need to acknowledge the policy, and sends an attestation request so each person is asked to confirm they have read it. This turns a manual send-and-chase into an automated rollout the agent can repeat whenever a policy changes.

Example prompt: List the available documents, then send an attestation request for the chosen policy document to the organization's people

### People Directory Onboarding

When a new hire joins, their record and group memberships must exist before policies can be assigned. The ClearPolicy API lets an agent add the person with the create-person endpoint and add them to the right groups, so onboarding automation keeps the people directory current without a manual admin step. The agent can read back the person record to confirm the add.

Example prompt: Add a new person with their name and email, then add that person to the group named Engineering

### Offboarding Group Removal

When someone leaves or changes teams, they should drop out of the groups that assign them policies. The ClearPolicy API exposes a remove-person operation on a group, so an offboarding agent can remove a departing person from each group they belonged to, keeping attestation assignments accurate. Group membership is addressed by group and person id, so the removal is precise.

Example prompt: Remove the person with the given id from the group with the given id

### Document and Group Inventory

Compliance teams need to know which policies exist and which groups they map to. The ClearPolicy API lists documents and groups so an agent can build an inventory of the organization's policies and the groups responsible for each, then flag any group that has no document assigned. It reads from organization-scoped endpoints so the view is the whole organization.

Example prompt: List all documents and all groups and return a table pairing each group with the policies it is responsible for

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/attestation-requests` | Send an attestation request |
| GET | `/people` | List people |
| POST | `/people` | Add a person |
| GET | `/people/{id}` | Get a person |
| GET | `/documents` | List documents |
| GET | `/groups` | List groups |
| POST | `/groups/{group}/people` | Add people to a group |
| DELETE | `/groups/{group}/people/{person}` | Remove a person from a group |

## Key resources

- **People** — List people, add a person, and look up a single person by id
- **Groups** — List groups, add people to a group, and remove a person from a group
- **Documents** — List the policy documents available for attestation
- **Attestation Requests** — Send an attestation request asking people to acknowledge a document
- **Me** — Read the current user and the role of the calling token

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 88 / 100
- **View full report:** https://jentic.com/apis/clearpolicy.app/clearpolicy/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the ClearPolicy API by hand means creating a bearer token with the api:use scope, tracking which role your token holds so writes do not 403, and honoring the per-token rate limit. Through Jentic you install once, import ClearPolicy from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** ClearPolicy puts the group and person id in the URL path (`/groups/{group}/people/{person}`), so a rule can pin your agent to the people and group operations you pick. You can let it list people, groups, and documents without granting the add-person, remove-person, or send-attestation operations.
- **Credential handling:** Your ClearPolicy token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a policy attestation request' or 'list people in the organization', and Jentic returns the matching ClearPolicy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Drata** — Compliance automation platform that includes policy acceptance alongside evidence collection.
- **Secureframe** — Security compliance platform with policy management and employee attestation.
- **BambooHR** — HR system of record that supplies the people and group data ClearPolicy assigns policies to.
- **PandaDoc** — Document agreements and e-signature, where ClearPolicy handles acknowledgement rather than signing.

## FAQ

### What authentication does the ClearPolicy API use?

The ClearPolicy API authenticates with a bearer token per its OpenAPI spec: a token created in ClearPolicy settings with the api:use scope, sent as an Authorization: Bearer header. Tokens are organization-scoped, and a Group Manager token can call the current-user endpoint while owner and administrator tokens reach the rest. Through Jentic the token is stored once by your own self-hosted instance and injected at call time, so it never sits in your agent's prompt or logs.

### Is there a ClearPolicy MCP server?

You do not need an MCP server to give your agent the ClearPolicy API. Jentic connects it directly from the API Directory: import it, store your API token once, and your agent calls the people, groups, documents, and attestation operations on demand. Operations are discovered when needed, so no extra server's tool definitions are loaded into the agent's context.

### Can I limit what my agent is allowed to do with the ClearPolicy API?

Yes. Write a rule that allows only the list-people, list-groups, and list-documents operations, so the agent can read your directory and policies but cannot add or remove people or send an attestation request. Every call it makes is logged, so you can audit exactly what the agent touched.

### Can I send policy attestation requests with the ClearPolicy API?

Yes. Send an attestation request with POST /attestation-requests, which asks the chosen people to acknowledge a document. You can list the documents available to attest at /documents and list the people who should receive the request at /people, so an agent can assemble and send a rollout in a few calls.

### What are the rate limits for the ClearPolicy API?

The OpenAPI spec states each API token is limited to 60 requests per minute. A 429 response carries a Retry-After header to wait on, and the X-RateLimit headers report your remaining allowance so an agent can pace its calls.

### How do I send a policy attestation with the ClearPolicy API through Jentic?

Search Jentic for 'send a policy attestation request' and it returns the POST /attestation-requests operation with its input schema. Pass the document and the people who must acknowledge it and the agent sends the request. To run it on your own infrastructure, install Jentic One from its GitHub repo.
