Skip to content
UltimateTeam.ai Docs

Prepare onboarding

POST
/api/v1/hiring/{process_id}/onboard/{candidate_id}
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/hiring/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/onboard/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "candidate_name": "example", "job_design_data": {}, "location": "United States", "salary": {} }'

Generate onboarding materials for a hired candidate.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
process_id
required
Process Id
string format: uuid
candidate_id
required
Candidate Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PrepareOnboardingRequest

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
Candidate Name

Full name of the hired candidate

string
>= 1 characters <= 200 characters
job_design_data
required
Job Design Data

Serialized JobDesign from the hiring process

object
key
additional properties
any
location
Location

Geographic location for compliance requirements

string
default: United States
salary
required
Salary

Salary terms (SalaryRange schema)

object
key
additional properties
any

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
OnboardingEnvelope

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

object
data
required
OnboardingResponse

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
Checklist

Structured onboarding checklist

object
key
additional properties
any
compliance_reminders
Compliance Reminders

Location-specific compliance items

Array<object>
object
key
additional properties
any
offer_letter
required
Offer Letter

Generated offer letter text

string
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Examplegenerated
{
  "data": {
    "checklist": {},
    "compliance_reminders": [
      {}
    ],
    "offer_letter": "example"
  },
  "meta": {
    "request_id": "example",
    "timestamp": "2026-04-15T12:00:00Z"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}