# Insperity

> Insperity is a professional employer organization (PEO) providing HR, payroll, benefits and
> workers' compensation services to small and medium-sized businesses. Its Insperity Premier
> platform exposes a REST Public API at https://api.insperity.com/public, organized into four
> categories — Onboarding, Payroll & Tax, HRIS and Core — totaling 45 publicly listed operations.
> The API is NOT open: a key is issued per customer by an Insperity Integration Specialist after an
> API Terms of Use Agreement is signed, requests must originate from allow-listed IP addresses, and
> the portal's Swagger documents return 401 to anonymous clients.

Generated by API Evangelist from this repository's artifacts on 2026-09-13. Insperity does not
publish an llms.txt of its own (developer.insperity.com/llms.txt returns the portal's Angular shell,
and every other Insperity host 404s or 403s the path). This file is a faithful summary of what was
fetched, not a provider document.

## Access

- [Get Started](https://developer.insperity.com/get-started): the onboarding sequence — sign the API Terms of Use Agreement, supply Insperity client IDs, supply IP addresses or ranges for allow-listing, receive a key by secure email. Keys expire annually.
- [Developer Resources](https://developer.insperity.com/developer-resources): the full public reference — schema, versioning, parameters, filtering, sorting, HTTP status codes, error codes, HTTP verbs, authentication, field value tables and character limits.
- [FAQ & Tips](https://developer.insperity.com/faq): commonly asked questions about the Insperity API.
- [API Categories](https://developer.insperity.com/categories): the API Explorer. The per-category operation lists are public; the Swagger documents behind them require a Premier account.

## Calling it

- Base URL (production): `https://api.insperity.com/public`
- Base URL (stage): `https://apistage.insperity.com/public` — de-identified copy of production, separate key, IP allow-listed
- Auth: `Authorization: APIKey <YourApiKey>` — the only method Insperity supports
- Media type: JSON only, over HTTPS. Blank fields should be omitted. All times ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`)
- Version: a required path segment, e.g. `/public/employee/addresschange/v1`
- Filtering: `?filter=<property> <op> "<value>"` with `eq`, `ne`, `gt`, `lt`, `contains`, `startswith`, `endswith`, combined with `and`/`or` and grouped with parentheses
- Sorting: `?sort=<property> asc|desc`
- Rate limits: none enforced, and no `RateLimit-*` or `Retry-After` headers are returned
- Idempotency: none. There is no idempotency key and no replay window; a repeated POST is a second real change request to a human service team
- Reversibility: none published. There is no cancel, void, reverse or undo operation and no stated window

## Writes are asynchronous

Every write is a named change event (`AddressChange`, `RemunerationChange`, `EmploymentStatusChange`,
`Onboarding`, …) POSTed to its own endpoint and queued for an Insperity service team. The response
carries a `trackingId`; poll `https://api.insperity.com/public/transaction/{trackingId}/status` for
`Success`, `Failed`, `In Progress`, `Authenticated` or `Error`. A 200 on the POST does not mean the
change was applied.

## APIs

- Onboarding — send candidate hire information to Insperity Premier Onboarding. 1 operation.
- Payroll & Tax — update employee compensation and retrieve general ledger information post payroll. 3 operations.
- HRIS — transfer employee information to and from Insperity Premier. 26 operations.
- Core — company-scoped reference data; the accepted values other endpoints require. 15 operations.

## Artifacts in this profile

- [Operation inventory](api-inventory/_index.yml): the 45 method+path pairs, fetched verbatim from Insperity's own public catalog endpoint
- [Authentication](authentication/insperity-authentication.yml)
- [Conventions](conventions/insperity-conventions.yml): filtering, sorting, versioning, identifiers, tracing, idempotency and reversibility verdicts
- [Error catalog](errors/insperity-problem-types.yml): status codes plus the named error-code registry
- [Rate limits](rate-limits/insperity-rate-limits.yml): a documented zero
- [Lifecycle](lifecycle/insperity-lifecycle.yml): versioning, key expiry, the per-operation deprecated flag
- [Sandbox](sandbox/insperity-sandbox.yml): the stage environment
- [Data model](data-model/insperity-data-model.yml): entities, relationships, field value tables and character limits
- [Conformance](conformance/insperity-conformance.yml)
- [Plans](plans/insperity-plans-pricing.yml): no published plans
- [Packages](packages/insperity-packages.yml): no client libraries on any registry
- [MCP](mcp/insperity-mcp.yml): no server exists; a candidate tool list derived from the real operation inventory
- [Well-known](well-known/insperity-well-known.yml): no discovery document on any host

## No agent surface

Insperity publishes no MCP server, no A2A agent card, no `/.well-known/` document of any kind, no
AsyncAPI, no webhooks it emits, no OpenAPI readable without a customer account, and no SDK on any
package registry. An agent cannot reach this API without a human first signing an agreement and an
IP allow-list entry being created.

## Alternatives to the API

- [Connectors](https://developer.insperity.com/connectors): Insperity-built integrations with BambooHR, Greenhouse, JazzHR, Workable Recruiting and Zoho Recruit
- FileFeeds: a standard or custom Insperity report output to an SFTP location on a schedule