EndUsers
Get an end user's background check verification
deprecated
Deprecated — use GET /end_users/{end_user_heron_id}/verification instead.
Returns a field-by-field verification of a submission’s subjects — the business and its owners — against every independent source that ran a KYB check for the submission.
For each field, the response gives a state, the independent sources consulted, and the
value each returned. States are:
verified— the merchant stated this value and an independent source agreesconflict— the merchant stated this value and an independent source disagreesnot_verified— no independent source confirmed itblank— no value was provided on the submission
GET
/
api
/
end_users
/
{end_user_heron_id}
/
background_check
/
verification
Get an end user's background check verification
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification"
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification', 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/verification",
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification"
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification")
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{
"business": {
"billing_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_email": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"dba": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"display_name": "<string>",
"ein": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"entity_type": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"facebook": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"industry": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"instagram": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"key": "<string>",
"legal_name": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"linkedin": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"standing": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"started_on": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"state_of_incorporation": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"status": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"status_raw": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"subject_type": "owner",
"website": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
}
},
"owners": [
{
"credit_scores": [
{
"chosen_by": "tin",
"chosen_score": {
"bureau": "equifax",
"score": 123,
"score_model": "fico",
"score_model_raw": "<string>",
"score_version_raw": "<string>",
"scored_on": "2023-12-25"
},
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
}
],
"date_of_birth": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"declared": true,
"display_name": "<string>",
"driving_licence": {
"agreement_score": 123,
"evidence_level": "signed_and_corroborated",
"expired": true,
"expires_on": "2023-12-25",
"flags": [
"<string>"
],
"issued_on": "2023-12-25",
"number": "<string>",
"pairing_status": "paired",
"signature_outcome": "<string>",
"state": "<string>"
},
"email": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"home_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"home_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"key": "<string>",
"linkedin": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"mobile_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"name": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"ownership_percentage": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"position": 123,
"relationship": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"ssn": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"subject_type": "owner"
}
]
}Authorizations
Path Parameters
The Heron ID of the end user
Response
OK
The company the deal applied as. Null when no source named one, which leaves nothing to verify.
Show child attributes
Show child attributes
Every person the deal's sources put at a share of the company. Ordered by the largest share stated, then the newest application form, then the order they appear on it. An owner stated through the API counts as older than any application form. The ones a form declared come before the ones only a source found.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get an end user's background check verification
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification"
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification', 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/verification",
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification"
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://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_heron_id}/background_check/verification")
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{
"business": {
"billing_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_email": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"business_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"dba": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"display_name": "<string>",
"ein": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"entity_type": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"facebook": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"industry": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"instagram": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"key": "<string>",
"legal_name": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"linkedin": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"standing": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"started_on": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"state_of_incorporation": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"status": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"status_raw": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"subject_type": "owner",
"website": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
}
},
"owners": [
{
"credit_scores": [
{
"chosen_by": "tin",
"chosen_score": {
"bureau": "equifax",
"score": 123,
"score_model": "fico",
"score_model_raw": "<string>",
"score_version_raw": "<string>",
"scored_on": "2023-12-25"
},
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
}
],
"date_of_birth": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"declared": true,
"display_name": "<string>",
"driving_licence": {
"agreement_score": 123,
"evidence_level": "signed_and_corroborated",
"expired": true,
"expires_on": "2023-12-25",
"flags": [
"<string>"
],
"issued_on": "2023-12-25",
"number": "<string>",
"pairing_status": "paired",
"signature_outcome": "<string>",
"state": "<string>"
},
"email": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"home_address": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"home_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"key": "<string>",
"linkedin": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"mobile_phone": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"name": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"ownership_percentage": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"position": 123,
"relationship": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"ssn": {
"chosen_by": "tin",
"label": "<string>",
"source_to_verify": "tin",
"sources": [
{
"source": "tin",
"source_inputs": {},
"value": "<string>",
"verification_status": "agree"
}
],
"state": "verified",
"value": "<string>"
},
"subject_type": "owner"
}
]
}