Skip to main content
POST
Trigger Scout Run

Authorizations

x-api-key
string
header
required

Each key carries scopes chosen when it is created: candidates:read, candidates:write, assessments:read, assessments:write, problems:read, problems:write, results:read, id_checks:read, id_checks:write. Keys created before scopes existed have full access. A request with a key that lacks an operation's scope returns 403 naming the missing scope.

Path Parameters

candidateId
string
required

The unique identifier of the candidate

Body

multipart/form-data
phone
string

The candidate's phone number, ideally in E.164 format. Optional: without one, phone checks are skipped and the verdict rests on the remaining signals.

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, resume checks are skipped. Scout still runs phone, email, and LinkedIn checks, 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.