Get status by external ID

GET /api/Subjects/{externalId}/screeningStatusByExternalId

Use status callbacks as the primary progress mechanism. These read endpoints are available for an individual diagnostic check; rechecking the status after every callback is unnecessary.

Authentication

Send your private API key in the X-Api-Key header. Keep it on your server.

Request example

Examples use illustrative values. Set FERRETLY_API_KEY in your server environment for JavaScript, Python, and C#. Replace sample IDs, URLs, and profile values before use.

curl --fail -sS -X GET "https://api.ferretly.com/api/Subjects/candidate-001/screeningStatusByExternalId" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch("https://api.ferretly.com/api/Subjects/candidate-001/screeningStatusByExternalId", {
  "method": "GET",
  "headers": {
    "X-Api-Key": process.env.FERRETLY_API_KEY,
    "Accept": "application/json"
  }
});
if (!response.ok) throw new Error("HTTP " + response.status);
console.log(await response.json());

import os
import requests

response = requests.request(
    "GET",
    "https://api.ferretly.com/api/Subjects/candidate-001/screeningStatusByExternalId",
    headers={"X-Api-Key":os.environ["FERRETLY_API_KEY"],"Accept":"application/json"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.ferretly.com/api/Subjects/candidate-001/screeningStatusByExternalId");
request.Headers.Add("X-Api-Key", Environment.GetEnvironmentVariable("FERRETLY_API_KEY"));
request.Headers.Accept.ParseAdd("application/json");
using var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Parameters

Name	In	Required	Type	Description
`externalId`	path	Yes	string	The “external” id value for the subject. This value is specified by the API client when the subject is created.

Responses

200

Success

text/plain: BackgroundCheckStatus
application/json: BackgroundCheckStatus
text/json: BackgroundCheckStatus

Response example

Illustrative, shortened HTTP 200 response. Optional fields can be absent or null.

"Complete"

Response properties