Skip to content
UltimateTeam.ai Docs

Screen a candidate

POST
/api/v1/hiring/screen

Evaluate a candidate against job requirements.

Authorizations

Request Body required

Request body for screening a candidate against a hiring process.

Attributes: hiring_process_id: UUID of the hiring process to screen against. candidate_id: UUID of the candidate being screened. job_design_data: Serialized JobDesign from the hiring process. application_data: Candidate’s application materials (resume text, answers to screening questions, etc.).

object
application_data
required

Candidate’s application materials

object
key
additional properties
any
candidate_id
required

ID of the candidate to screen

string format: uuid
hiring_process_id
required

ID of the hiring process

string format: uuid
job_design_data
required

Serialized JobDesign from the hiring process

object
key
additional properties
any

Responses

200

Successful Response

Typed envelope for POST /screen.

object
data
required

Response body for a candidate screening result.

Attributes: candidate_id: UUID of the screened candidate. fit_score: Overall fit score from 0 to 100. recommendation: Overall recommendation (recommend, maybe, pass). strengths: Key strengths identified for this role. concerns: Areas of concern about the candidate. reasoning: Detailed reasoning behind the recommendation.

object
candidate_id
required

ID of the screened candidate

string format: uuid
concerns

Areas of concern about this candidate

Array<string>
fit_score
required

Overall fit score from 0 to 100

integer
<= 100
reasoning
required

Detailed reasoning behind the recommendation

string
recommendation
required

Overall recommendation: recommend, maybe, or pass

string
strengths
required

Candidate’s key strengths for this role

Array<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