Skip to main content

Onboarding API Operations

Summary​

Verified onboarding operations list tenant projections, report joining totals, create or reuse onboarding from accepted offers, change status, join a candidate, and complete through compatibility input. Exact method/route pairs appear only in the endpoint catalog.

Audience​

Developers, QA, support, and solution architects.

Endpoint grouping​

Native behavior​

  • Listing and joining-report queries are tenant scoped.
  • Move-to-onboarding requires an accepted offer and reuses an active aggregate for idempotence.
  • Status input is parsed against the onboarding enumeration.
  • Requesting Completed triggers employee initialization; a completed aggregate is terminal and repeated completion is a success.
  • Candidate join locates the latest accepted offer, creates onboarding if absent, then completes it.

Compatibility behavior​

Compatibility status forbids marking Completed and directs callers to the dedicated completion operation. The extracted compatibility completion accepts the legacy DTO but uses only a subset of it to drive extracted completion and construct the response. The monolith completion directly creates labor and user records and persists richer profile data.

Query responses​

The native onboarding projection exposes aggregate lifecycle and created-employee readiness fields. Compatibility workspace returns monolith-shaped onboarding rows plus surrounding Recruitment lookup data. Joining totals group Pending, In Progress, Completed, Cancelled, and Login Pending.

Requires confirmation​

  • Whether native completion should have a dedicated operation instead of status mutation.
  • Required parity for compatibility profile fields and login readiness.
  • Pagination and sorting requirements for large onboarding lists.
  • Whether candidate join remains supported alongside offer move and compatibility completion.

Source References​

  • microservices/src/recruitment-service/Api/RecruitmentEndpoints.cs
  • microservices/src/recruitment-service/Api/RecruitmentCompatEndpoints.cs
  • microservices/src/recruitment-service/Application/Commands/OnboardingCommands.cs
  • microservices/src/recruitment-service/Application/Queries/RecruitmentQueries.cs
  • microservices/src/recruitment-service/Application/Compatibility/CompatCommands.cs
  • Controllers/RecruitmentController.cs
  • UI/salary-ui/apps/client-hrms-portal/src/pages/hr/RecruitmentOnboardingPage.tsx

See Also​

Keywords​

  • Onboarding transition
  • Candidate join
  • Joining report

Revision Information​

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