Pinkerton AI - AI-Native Back Office Operations

Developers

DEVELOPERPORTAL.

Build on top of Pinkerton. RESTful APIs, webhooks, and integration SDKs for payroll, HR, and compliance automation.

API Surface

Runs, periods, items, earnings codes, deductions, journal entries.

POST /v1/payroll/runsGET /v1/payroll/periodsGET /v1/payroll/items/:idPOST /v1/payroll/journal-entries

Employees, departments, documents, emergency contacts, analytics.

GET /v1/hr/employeesPOST /v1/hr/departmentsGET /v1/hr/documents/:idGET /v1/hr/analytics/headcount

Plans, enrollments, eligibility, life events.

GET /v1/benefits/plansPOST /v1/benefits/enrollmentsGET /v1/benefits/eligibility/:idPOST /v1/benefits/life-events

Filings, deadlines, ACA, I-9, tax deposits.

GET /v1/compliance/filingsGET /v1/compliance/deadlinesPOST /v1/compliance/aca/submitGET /v1/compliance/tax-deposits

Authentication

TOKEN-BASED AUTH.

Every API request is authenticated with a signed JWT. Scoped permissions ensure least-privilege access across all service domains.

1Get your API key

# Generate key from the Pinkerton dashboard
# Settings > API > Create Key

2Exchange for a JWT

POST /v1/auth/token
Content-Type: application/json

{
  "api_key": "pk_live_xxxxxxxx",
  "scope": ["payroll:read", "hr:write"]
}

3Use the Bearer token

GET /v1/payroll/runs
Authorization: Bearer eyJhbGciOiJSUzI1NiIs...

Webhooks

Subscribe to real-time events from any Pinkerton service. Webhooks are signed, retried on failure, and include full event payloads.

payroll.run.completed

Fires when a payroll run finishes processing. Includes run ID, period, and summary totals.

employee.status.changed

Fires on hire, termination, leave, or status transitions. Includes previous and new status.

compliance.deadline.approaching

Fires 30, 14, and 7 days before a filing deadline. Includes filing type and jurisdiction.

integration.sync.completed

Fires when an external integration sync finishes. Includes record counts and error summary.

SDKs

pip install pinkerton-sdk

Coming Soon

npm install @pinkerton/sdk

Coming Soon

Direct HTTP. OpenAPI 3.1 spec available.

Coming Soon

Get an API key and start building on Pinkerton infrastructure today.