Onboarding & Offboarding API Documentation

Summary

The verified lifecycle API surface contains 36 operations: 33 inbound lifecycle or host-foundation operations, two outbound Employee Service operations used during extracted completion, and one adjacent Recruitment workflow callback that does not orchestrate onboarding or offboarding.

Audience

Developers, QA and support engineers, implementation partners, architects, and security reviewers working with lifecycle APIs.

Overview

Surface	Operations
Recruitment host foundation	3
Native and public Recruitment lifecycle	9
Compatibility lifecycle routes	8
Monolith HR Operations lifecycle	13
Outbound Employee Service handoff	2
Adjacent requisition workflow callback	1
Total	36

Compatibility method/route pairs are counted once even though gateway selection can send them to either the monolith or extracted Recruitment implementation. Generated OpenAPI middleware and gateway catch-all proxy patterns are not counted as business operations.

Documentation map

• API overview and authoritative endpoint catalog
• Authentication, authorization, and tenant context
• Request lifecycle
• Offer acceptance, onboarding, and offboarding
• Employee initialization and checklist boundaries
• Workflow and notification boundaries
• Compatibility and gateway boundaries
• DTO catalog, validation, responses, and errors
• Health and discovery, versioning, and API testing
• API limitations and source map

All pages remain Draft. No operation in this section is presented as a production-readiness guarantee.

Requires confirmation

Production exposure, extracted endpoint authorization, trusted tenant forwarding, compatibility cutover, response parity, sensitive completion-response handling, and release-test ownership require confirmation.

Source References

• microservices/src/recruitment-service/Program.cs
• microservices/src/recruitment-service/Api/RecruitmentEndpoints.cs
• microservices/src/recruitment-service/Api/RecruitmentPublicEndpoints.cs
• microservices/src/recruitment-service/Api/RecruitmentCompatEndpoints.cs
• Controllers/RecruitmentController.cs
• Controllers/HrOperationsController.cs
• microservices/src/gateway-api/Program.cs
• microservices/src/recruitment-service/Infrastructure/EmployeeServiceClient.cs

Related Articles

• API overview
• Technical documentation

See Also

• API limitations
• API source map

Keywords

• Lifecycle API
• Compatibility endpoints
• Exit request API

Revision Information

• Status: Draft
• Last reviewed: 2026-07-20
• Review cycle: Quarterly