Skip to content
UltimateTeam.ai Docs

Screen a candidate

POST
/api/v1/hiring/screen
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/hiring/screen \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "application_data": {}, "candidate_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hiring_process_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "job_design_data": {} }'

Evaluate a candidate against job requirements.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ScreenCandidateRequest

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
Application Data

Candidate’s application materials

object
key
additional properties
any
candidate_id
required
Candidate Id

ID of the candidate to screen

string format: uuid
hiring_process_id
required
Hiring Process Id

ID of the hiring process

string format: uuid
job_design_data
required
Job Design Data

Serialized JobDesign from the hiring process

object
key
additional properties
any
Examplegenerated
{
  "application_data": {},
  "candidate_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "hiring_process_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "job_design_data": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ScreenCandidateEnvelope

Typed envelope for POST /screen.

object
data
required
ScreeningResultResponse

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

ID of the screened candidate

string format: uuid
concerns
Concerns

Areas of concern about this candidate

Array<string>
fit_score
required
Fit Score

Overall fit score from 0 to 100

integer
<= 100
reasoning
required
Reasoning

Detailed reasoning behind the recommendation

string
recommendation
required
Recommendation

Overall recommendation: recommend, maybe, or pass

string
strengths
required
Strengths

Candidate’s key strengths for this role

Array<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": {
    "candidate_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "concerns": [
      "example"
    ],
    "fit_score": 1,
    "reasoning": "example",
    "recommendation": "example",
    "strengths": [
      "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"
    }
  ]
}