> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ropes.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get candidate Scout result

> Get a candidate's Scout result (resume and identity fraud screening): the overall verdict, a human-readable summary, and per-check findings. Read-only. The `status` field indicates whether a Scout run exists and whether results are available; `risk`, `summary`, and the flag arrays are only populated when status is "completed".



## OpenAPI

````yaml https://api.ropes.ai/api/docs/openapi.json get /api/public/candidates/{identifier}/scout
openapi: 3.0.0
info:
  title: Ropes Public API
  version: 1.0.0
  description: >-
    Public API for Ropes. Authenticate using your API key in the x-api-key
    header.
servers:
  - url: https://api.ropes.ai
    description: Production server
  - url: http://localhost:3001
    description: Local development server
security: []
paths:
  /api/public/candidates/{identifier}/scout:
    get:
      tags:
        - Scout
      summary: Get candidate Scout result
      description: >-
        Get a candidate's Scout result (resume and identity fraud screening):
        the overall verdict, a human-readable summary, and per-check findings.
        Read-only. The `status` field indicates whether a Scout run exists and
        whether results are available; `risk`, `summary`, and the flag arrays
        are only populated when status is "completed".
      parameters:
        - schema:
            type: string
            description: The unique identifier of the candidate
          required: true
          description: The unique identifier of the candidate
          name: identifier
          in: path
      responses:
        '200':
          description: Successfully retrieved Scout result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutResult'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '404':
          description: Candidate not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ScoutResult:
      type: object
      properties:
        status:
          type: string
          enum:
            - not_run
            - processing
            - completed
          description: >-
            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.
        completedAt:
          type: string
          nullable: true
          format: date-time
          description: >-
            ISO 8601 timestamp when the Scout run completed. Null unless
            completed.
        risk:
          type: string
          nullable: true
          enum:
            - Checks Passed
            - Review Recommended
            - Insufficient Data
          description: >-
            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.
        summary:
          type: string
          nullable: true
          description: >-
            Human-readable summary of the Scout assessment. Null unless
            completed.
        flags:
          type: array
          items:
            $ref: '#/components/schemas/ScoutFlag'
          description: >-
            Findings that did not pass (including checks that were skipped).
            Empty unless completed.
        passingFlags:
          type: array
          items:
            $ref: '#/components/schemas/ScoutFlag'
          description: Checks the candidate cleared. Empty unless completed.
      required:
        - status
        - completedAt
        - risk
        - summary
        - flags
        - passingFlags
      additionalProperties: false
    ScoutErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Error message (alternative field)
    ScoutFlag:
      type: object
      properties:
        id:
          type: string
          description: Stable machine identifier for the check that produced this finding.
        title:
          type: string
          description: Short human-readable name of the finding.
        description:
          type: string
          description: Human-readable explanation of the finding for this candidate.
        level:
          type: string
          enum:
            - critical
            - warning
            - notice
            - pass
            - skipped
          description: >-
            Severity of the finding. "pass" = check cleared; "skipped" = check
            could not be performed (e.g. missing input).
        hint:
          type: string
          description: Additional context about what this check evaluates.
      required:
        - id
        - title
        - description
        - level
        - hint
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````