Pin CLEAR candidate overrides for a background check
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override"
payload = {
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({business: '<string>', owner_1: '<string>', owner_2: '<string>'})
};
fetch('https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override', 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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business' => '<string>',
'owner_1' => '<string>',
'owner_2' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override"
payload := strings.NewReader("{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}EndUsers
Pin CLEAR candidate overrides for a background check
Pins a CLEAR entity_id per subject (owner_1, owner_2, business) so the enricher fetches that candidate’s report directly and skips its search. A null value clears that subject’s pin; unpinned subjects still run the full search waterfall. Returns the current pins.
POST
/
api
/
end_users
/
{end_user_heron_id}
/
background_check
/
override
Pin CLEAR candidate overrides for a background check
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override"
payload = {
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({business: '<string>', owner_1: '<string>', owner_2: '<string>'})
};
fetch('https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override', 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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business' => '<string>',
'owner_1' => '<string>',
'owner_2' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override"
payload := strings.NewReader("{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business\": \"<string>\",\n \"owner_1\": \"<string>\",\n \"owner_2\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"business": "<string>",
"owner_1": "<string>",
"owner_2": "<string>"
}Was this page helpful?
Get the pinned CLEAR candidate overrides for a background checkClear all CLEAR candidate overrides for a background check
⌘I