canonical: https://jentic.com/apis/truora.com/checks-api

# Truora Checks API

**NOTE:** This is a preview of the API and it is not considered stable since refinements are still being made. Introduction Welcome to the **Truora Check** [**RESTful API**](https://en.wikipedia.org/wiki/Representational_state_transfer) reference. You may also want to check out our [**Validations API docs**](https://docs.validations.truora.com/) or our [**Signals API docs**](https://docs.signals.t. The API exposes 25 endpoints secured with apiKey authentication.

## For AI agents

Programmatically report behavior, create a background check. Covers 25 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for productivity only.

## Capabilities

- Report Behavior
- Create a background check
- List Checks
- Get Health Dashboard
- Monitor Checks API operational status and events

## Use cases

### Productivity Operations

Use the Checks API to perform productivity operations programmatically. The API provides 25 endpoints covering core functionality including report behavior, create a background check, list checks.

Example prompt: Call POST `/v1/behavior` to report behavior

### Automated checks Management

Automate checks operations by combining multiple Checks API endpoints. Agents can create a background check and then list checks in a single workflow.

Example prompt: Call POST `/v1/checks` to create a background check, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Checks API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'report behavior', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/behavior` | Report Behavior |
| POST | `/v1/checks` | Create a background check |
| GET | `/v1/checks` | List Checks |
| GET | `/v1/checks/health` | Get Health Dashboard |
| GET | `/v1/checks/{check_id}` | Get Background Check |
| GET | `/v1/checks/{check_id}/details` | List Check Details |
| POST | `/v1/checks/{check_id}/pdf` | Create PDF |
| GET | `/v1/checks/{check_id}/pdf` | Get PDF |

## Key resources

- **checks** — Allows you to create and retrieve background checks. Consults multiple databases and delivers a comp
- **reports** — The reports API let you group checks into a single report and download the result as a PDF or CSV fi
- **custom-type** — The Custom Type API allows the creation of new products so only desired datasets are included in bac
- **behavior** — Allows to anonymously report a person behavior. This information is fed to our machine learning plat
- **hooks** — Hooks allows configuring Truora Platform to notify via requests to your service (or another third-pa

## Why Jentic

- **Setup:** Wiring Checks API by hand means setting its Truora-API-Key header, tracking check ids across calls, and handling errors and retries yourself. Through Jentic you install once, import Checks API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Checks API puts the check id in the URL path (`/v1/checks/{check_id}/...`), so a rule can pin your agent to one check: it can read that check's details and generate its PDF and nothing else. You choose the operations it may call, so creating new checks or reporting behavior are not included unless you add them.
- **Credential handling:** Your Checks API key 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 'create a background check' or 'get a check's PDF report', and Jentic returns the matching Checks API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the Checks API use?

The Checks API uses an API key passed in the `Truora-API-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I report behavior with the Checks API?

Yes. Use the POST `/v1/behavior` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

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

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I report behavior through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'report behavior'. Jentic returns the matching Checks API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Checks API have?

The Checks API exposes 25 endpoints covering checks, reports, custom-type operations.

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

Yes. Because Jentic One is self-hosted, your own rules decide which Checks API operations and credentials the agent may use. Since the check id lives in the URL path (`/v1/checks/{check_id}/...`), you can pin the agent to a single check so it only reads that check's details and generates its PDF. You choose the operations it can call, so creating new background checks or reporting behavior stay off-limits unless you add them.