# HR Operations API

> Read supplied employee records and policies, list missing or expired documents, and build onboarding and offboarding checklists from those policies.

- Product: https://www.brainiac.software/api/hr-operations
- Docs: https://www.brainiac.software/api/hr-operations/docs
- OpenAPI: https://www.brainiac.software/api/hr-operations/openapi.json
- Contact: support@brainiac.software (https://www.brainiac.software/contact)

## Operations

- POST /api/v1/hr-operations/employee-document-extract — $0.04 USDC — Extract employee documents: Read employee records and labeled document lines supplied by the caller. Dates, roles, and document types are returned as supplied. Document numbers are masked. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-employee-document-extract
- POST /api/v1/hr-operations/employee-record-validate — $0.04 USDC — Validate employee records: Compare employee records with the required fields supplied by the caller, and report an end date that falls before the start date. No legal requirement is added. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-employee-record-validate
- POST /api/v1/hr-operations/employee-policy-acknowledgement-check — $0.04 USDC — Check policy acknowledgements: Match supplied acknowledgements to supplied policies by policy id. An acknowledgement dated before the policy date is stale. This is not a compliance determination. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-employee-policy-acknowledgement-check
- POST /api/v1/hr-operations/employee-onboarding-checklist — $0.05 USDC — List onboarding tasks: Build an onboarding checklist only from supplied onboarding policies. A document or acknowledgement counts only when it matches that policy. No statutory form is added. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-employee-onboarding-checklist
- POST /api/v1/hr-operations/employee-offboarding-checklist — $0.05 USDC — List offboarding tasks: Build an offboarding checklist only from supplied offboarding policies. A task is met only by a supplied completion record. Access is not changed. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-employee-offboarding-checklist
- POST /api/v1/hr-operations/job-role-description-compare — $0.04 USDC — Compare a role description: Compare Duty lines in a role description with Duty lines supplied for an employee. Unlabeled prose is not a duty. The comparison is not an employment decision. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-job-role-description-compare
- POST /api/v1/hr-operations/workforce-document-expiry-check — $0.04 USDC — Check document expiry: Compare supplied expiry dates with a supplied as-of date. A document is due only inside the supplied day window. No date is invented when the as-of date is missing. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-workforce-document-expiry-check
- POST /api/v1/hr-operations/record-completeness-report — $0.12 USDC — Report personnel record completeness: Combine supplied records, document dates, policy acknowledgements, onboarding and offboarding items, and role duties. The report does not determine legal compliance or change access. Docs: https://www.brainiac.software/api/hr-operations/docs#hr-operations-record-completeness-report