Skip to content
UltimateTeam.ai Docs

Prepare onboarding

POST
/api/v1/hiring/{process_id}/onboard/{candidate_id}

Generate onboarding materials for a hired candidate.

Authorizations

Parameters

Path Parameters

process_id
required
string format: uuid
candidate_id
required
string format: uuid

Request Body required

Request body for preparing onboarding materials.

Attributes: job_design_data: Serialized JobDesign from the hiring process. candidate_name: Full name of the hired candidate. salary: Salary terms (min_amount, max_amount, basis, currency). location: Geographic location for compliance requirements.

object
candidate_name
required

Full name of the hired candidate

string
>= 1 characters <= 200 characters
job_design_data
required

Serialized JobDesign from the hiring process

object
key
additional properties
any
location

Geographic location for compliance requirements

string
default: United States
salary
required

Salary terms (SalaryRange schema)

object
key
additional properties
any

Responses

200

Successful Response

Typed envelope for POST /{process_id}/onboard/{candidate_id}.

object
data
required

Response body with prepared onboarding materials.

Attributes: offer_letter: Generated offer letter text. checklist: Structured onboarding checklist. compliance_reminders: Location-specific compliance items.

object
checklist
required

Structured onboarding checklist

object
key
additional properties
any
compliance_reminders

Location-specific compliance items

Array<object>
object
key
additional properties
any
offer_letter
required

Generated offer letter text

string
meta
required

Standard metadata attached to every API response.

object
request_id
required

Unique request identifier

string
timestamp
required

Server timestamp of the response

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string