Skip to main content
GET
Get Scout Result

Authorizations

x-api-key
string
header
required

Path Parameters

candidateId
string
required

The unique identifier of the candidate

Response

Successfully retrieved Scout result

status
enum<string>
required

Lifecycle of the Scout run for this candidate. "not_run" = no Scout run exists; "processing" = a run is in progress; "completed" = results are available below.

Available options:
not_run,
processing,
completed
completedAt
string<date-time> | null
required

ISO 8601 timestamp when the Scout run completed. Null unless completed.

risk
enum<string> | null
required

Overall Scout verdict. "Checks Passed" = no concerns; "Review Recommended" = manual review advised; "Insufficient Data" = not enough information to assess (NOT a clean result). Null unless completed.

Available options:
Checks Passed,
Review Recommended,
Insufficient Data
summary
string | null
required

Human-readable summary of the Scout assessment. Null unless completed.

flags
object[]
required

Findings that did not pass (including checks that were skipped). Empty unless completed.

passingFlags
object[]
required

Checks the candidate cleared. Empty unless completed.