Request background check reports for affiliations
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"affiliates": [
{
"index": 1,
"name": "<string>",
"search_inputs": {
"city": "<string>",
"date_of_birth": "2023-12-25",
"phone": "<string>",
"state": "<string>",
"street": "<string>",
"zip_code": "<string>"
}
}
]
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports"
payload = { "affiliates": [
{
"index": 1,
"name": "<string>",
"search_inputs": {
"city": "<string>",
"date_of_birth": "2023-12-25",
"phone": "<string>",
"state": "<string>",
"street": "<string>",
"zip_code": "<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({
affiliates: [
{
index: 1,
name: '<string>',
search_inputs: {
city: '<string>',
date_of_birth: '2023-12-25',
phone: '<string>',
state: '<string>',
street: '<string>',
zip_code: '<string>'
}
}
]
})
};
fetch('https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports', 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/affiliations/reports",
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([
'affiliates' => [
[
'index' => 1,
'name' => '<string>',
'search_inputs' => [
'city' => '<string>',
'date_of_birth' => '2023-12-25',
'phone' => '<string>',
'state' => '<string>',
'street' => '<string>',
'zip_code' => '<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/affiliations/reports"
payload := strings.NewReader("{\n \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\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/affiliations/reports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports")
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 \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requests": [
{
"ref": "<string>"
}
]
}EndUsers
Request background check reports for affiliations
Requests a background check report for each affiliation selected, business or person. Where the source records already identify the party, its report is retrieved for that party directly; otherwise a search runs first, and a search that settles on no single party returns not_found along with the parties it did find, so one can be confirmed. Poll the affiliations endpoint for progress.
POST
/
api
/
end_users
/
{end_user_heron_id}
/
background_check
/
affiliations
/
reports
Request background check reports for affiliations
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"affiliates": [
{
"index": 1,
"name": "<string>",
"search_inputs": {
"city": "<string>",
"date_of_birth": "2023-12-25",
"phone": "<string>",
"state": "<string>",
"street": "<string>",
"zip_code": "<string>"
}
}
]
}
'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports"
payload = { "affiliates": [
{
"index": 1,
"name": "<string>",
"search_inputs": {
"city": "<string>",
"date_of_birth": "2023-12-25",
"phone": "<string>",
"state": "<string>",
"street": "<string>",
"zip_code": "<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({
affiliates: [
{
index: 1,
name: '<string>',
search_inputs: {
city: '<string>',
date_of_birth: '2023-12-25',
phone: '<string>',
state: '<string>',
street: '<string>',
zip_code: '<string>'
}
}
]
})
};
fetch('https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports', 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/affiliations/reports",
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([
'affiliates' => [
[
'index' => 1,
'name' => '<string>',
'search_inputs' => [
'city' => '<string>',
'date_of_birth' => '2023-12-25',
'phone' => '<string>',
'state' => '<string>',
'street' => '<string>',
'zip_code' => '<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/affiliations/reports"
payload := strings.NewReader("{\n \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\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/affiliations/reports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/affiliations/reports")
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 \"affiliates\": [\n {\n \"index\": 1,\n \"name\": \"<string>\",\n \"search_inputs\": {\n \"city\": \"<string>\",\n \"date_of_birth\": \"2023-12-25\",\n \"phone\": \"<string>\",\n \"state\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requests": [
{
"ref": "<string>"
}
]
}Authorizations
Path Parameters
The Heron ID of the end user
Body
application/json
The affiliations to request CLEAR reports for, at most 25 per request.
Required array length:
1 - 25 elementsShow child attributes
Show child attributes
Response
Report requests accepted
One entry per selection: the report request accepted for processing, or the in-flight request it was deduplicated against.
Show child attributes
Show child attributes
Was this page helpful?
⌘I