Skip to main content
POST
Trigger Scout Run

Authorizations

x-api-key
string
header
required

Path Parameters

candidateId
string
required

The unique identifier of the candidate

Body

multipart/form-data
phone
string
required

The candidate's phone number, ideally in E.164 format.

linkedinUrl
string

URL of the candidate's LinkedIn profile.

githubUrl
string

URL of the candidate's GitHub profile.

resumes
file[]

Up to 10 resume files (PDF, DOC, or DOCX; max 10 MB each). Optional: without one, Scout verifies experience from LinkedIn and re-checks resumes from any prior run.

Response

Scout run queued

status
enum<string>
required

The Scout run has been queued.

Available options:
processing
candidateIdentifier
string
required

Identifier of the candidate being screened.

message
string
required

Human-readable confirmation.