Skip to main content
GET
/
api
/
public
/
candidates
/
{identifier}
/
scout
Get candidate Scout result
curl --request GET \
  --url https://api.ropes.ai/api/public/candidates/{identifier}/scout \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.ropes.ai/api/public/candidates/{identifier}/scout"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.ropes.ai/api/public/candidates/{identifier}/scout', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ropes.ai/api/public/candidates/{identifier}/scout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.ropes.ai/api/public/candidates/{identifier}/scout"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ropes.ai/api/public/candidates/{identifier}/scout")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ropes.ai/api/public/candidates/{identifier}/scout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "completedAt": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "flags": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "hint": "<string>"
    }
  ],
  "passingFlags": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "hint": "<string>"
    }
  ]
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

identifier
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.