Skip to main content
PATCH
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
end_user_information
Patch EndUser information
curl --request PATCH \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount_requested": 123,
  "annual_revenue": 123,
  "business_start_date": "2023-12-25",
  "company_billing_address": {
    "city": "<string>",
    "line_1": "<string>",
    "line_2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "company_email": "<string>",
  "company_legal_business_name": "<string>",
  "company_phone_number": "<string>",
  "company_physical_address": {
    "city": "<string>",
    "line_1": "<string>",
    "line_2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "company_website": "<string>",
  "dba": "<string>",
  "federal_tax_id": "<string>",
  "industry_type": "<string>",
  "loan_purpose": "<string>",
  "monthly_revenue": 123,
  "naics": "<string>",
  "owner_1": {
    "credit_score": 123,
    "date_of_birth": "1990-01-01",
    "email_address": "<string>",
    "first_name": "<string>",
    "has_signed": true,
    "home_address": {
      "city": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "home_phone": "<string>",
    "last_name": "<string>",
    "mobile_phone": "<string>",
    "ownership_percentage": 100,
    "signed_date": "2023-12-25",
    "social_security_number": "<string>"
  },
  "owner_2": {
    "credit_score": 123,
    "date_of_birth": "1990-01-01",
    "email_address": "<string>",
    "first_name": "<string>",
    "has_signed": true,
    "home_address": {
      "city": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "home_phone": "<string>",
    "last_name": "<string>",
    "mobile_phone": "<string>",
    "ownership_percentage": 100,
    "signed_date": "2023-12-25",
    "social_security_number": "<string>"
  },
  "predicted_industry_probability": 123,
  "source_email_address": "<string>",
  "source_name": "<string>",
  "source_notes": "<string>",
  "state_of_incorporation": "<string>",
  "type_of_business_entity": "<string>"
}
'
import requests

url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information"

payload = {
"amount_requested": 123,
"annual_revenue": 123,
"business_start_date": "2023-12-25",
"company_billing_address": {
"city": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"company_email": "<string>",
"company_legal_business_name": "<string>",
"company_phone_number": "<string>",
"company_physical_address": {
"city": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"company_website": "<string>",
"dba": "<string>",
"federal_tax_id": "<string>",
"industry_type": "<string>",
"loan_purpose": "<string>",
"monthly_revenue": 123,
"naics": "<string>",
"owner_1": {
"credit_score": 123,
"date_of_birth": "1990-01-01",
"email_address": "<string>",
"first_name": "<string>",
"has_signed": True,
"home_address": {
"city": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"home_phone": "<string>",
"last_name": "<string>",
"mobile_phone": "<string>",
"ownership_percentage": 100,
"signed_date": "2023-12-25",
"social_security_number": "<string>"
},
"owner_2": {
"credit_score": 123,
"date_of_birth": "1990-01-01",
"email_address": "<string>",
"first_name": "<string>",
"has_signed": True,
"home_address": {
"city": "<string>",
"line_1": "<string>",
"line_2": "<string>",
"state": "<string>",
"zip": "<string>"
},
"home_phone": "<string>",
"last_name": "<string>",
"mobile_phone": "<string>",
"ownership_percentage": 100,
"signed_date": "2023-12-25",
"social_security_number": "<string>"
},
"predicted_industry_probability": 123,
"source_email_address": "<string>",
"source_name": "<string>",
"source_notes": "<string>",
"state_of_incorporation": "<string>",
"type_of_business_entity": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount_requested: 123,
annual_revenue: 123,
business_start_date: '2023-12-25',
company_billing_address: {
city: '<string>',
line_1: '<string>',
line_2: '<string>',
state: '<string>',
zip: '<string>'
},
company_email: '<string>',
company_legal_business_name: '<string>',
company_phone_number: '<string>',
company_physical_address: {
city: '<string>',
line_1: '<string>',
line_2: '<string>',
state: '<string>',
zip: '<string>'
},
company_website: '<string>',
dba: '<string>',
federal_tax_id: '<string>',
industry_type: '<string>',
loan_purpose: '<string>',
monthly_revenue: 123,
naics: '<string>',
owner_1: {
credit_score: 123,
date_of_birth: '1990-01-01',
email_address: '<string>',
first_name: '<string>',
has_signed: true,
home_address: {
city: '<string>',
line_1: '<string>',
line_2: '<string>',
state: '<string>',
zip: '<string>'
},
home_phone: '<string>',
last_name: '<string>',
mobile_phone: '<string>',
ownership_percentage: 100,
signed_date: '2023-12-25',
social_security_number: '<string>'
},
owner_2: {
credit_score: 123,
date_of_birth: '1990-01-01',
email_address: '<string>',
first_name: '<string>',
has_signed: true,
home_address: {
city: '<string>',
line_1: '<string>',
line_2: '<string>',
state: '<string>',
zip: '<string>'
},
home_phone: '<string>',
last_name: '<string>',
mobile_phone: '<string>',
ownership_percentage: 100,
signed_date: '2023-12-25',
social_security_number: '<string>'
},
predicted_industry_probability: 123,
source_email_address: '<string>',
source_name: '<string>',
source_notes: '<string>',
state_of_incorporation: '<string>',
type_of_business_entity: '<string>'
})
};

fetch('https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information', 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_id_or_heron_id}/end_user_information",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'amount_requested' => 123,
'annual_revenue' => 123,
'business_start_date' => '2023-12-25',
'company_billing_address' => [
'city' => '<string>',
'line_1' => '<string>',
'line_2' => '<string>',
'state' => '<string>',
'zip' => '<string>'
],
'company_email' => '<string>',
'company_legal_business_name' => '<string>',
'company_phone_number' => '<string>',
'company_physical_address' => [
'city' => '<string>',
'line_1' => '<string>',
'line_2' => '<string>',
'state' => '<string>',
'zip' => '<string>'
],
'company_website' => '<string>',
'dba' => '<string>',
'federal_tax_id' => '<string>',
'industry_type' => '<string>',
'loan_purpose' => '<string>',
'monthly_revenue' => 123,
'naics' => '<string>',
'owner_1' => [
'credit_score' => 123,
'date_of_birth' => '1990-01-01',
'email_address' => '<string>',
'first_name' => '<string>',
'has_signed' => true,
'home_address' => [
'city' => '<string>',
'line_1' => '<string>',
'line_2' => '<string>',
'state' => '<string>',
'zip' => '<string>'
],
'home_phone' => '<string>',
'last_name' => '<string>',
'mobile_phone' => '<string>',
'ownership_percentage' => 100,
'signed_date' => '2023-12-25',
'social_security_number' => '<string>'
],
'owner_2' => [
'credit_score' => 123,
'date_of_birth' => '1990-01-01',
'email_address' => '<string>',
'first_name' => '<string>',
'has_signed' => true,
'home_address' => [
'city' => '<string>',
'line_1' => '<string>',
'line_2' => '<string>',
'state' => '<string>',
'zip' => '<string>'
],
'home_phone' => '<string>',
'last_name' => '<string>',
'mobile_phone' => '<string>',
'ownership_percentage' => 100,
'signed_date' => '2023-12-25',
'social_security_number' => '<string>'
],
'predicted_industry_probability' => 123,
'source_email_address' => '<string>',
'source_name' => '<string>',
'source_notes' => '<string>',
'state_of_incorporation' => '<string>',
'type_of_business_entity' => '<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_id_or_heron_id}/end_user_information"

payload := strings.NewReader("{\n \"amount_requested\": 123,\n \"annual_revenue\": 123,\n \"business_start_date\": \"2023-12-25\",\n \"company_billing_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_email\": \"<string>\",\n \"company_legal_business_name\": \"<string>\",\n \"company_phone_number\": \"<string>\",\n \"company_physical_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_website\": \"<string>\",\n \"dba\": \"<string>\",\n \"federal_tax_id\": \"<string>\",\n \"industry_type\": \"<string>\",\n \"loan_purpose\": \"<string>\",\n \"monthly_revenue\": 123,\n \"naics\": \"<string>\",\n \"owner_1\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"owner_2\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"predicted_industry_probability\": 123,\n \"source_email_address\": \"<string>\",\n \"source_name\": \"<string>\",\n \"source_notes\": \"<string>\",\n \"state_of_incorporation\": \"<string>\",\n \"type_of_business_entity\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount_requested\": 123,\n \"annual_revenue\": 123,\n \"business_start_date\": \"2023-12-25\",\n \"company_billing_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_email\": \"<string>\",\n \"company_legal_business_name\": \"<string>\",\n \"company_phone_number\": \"<string>\",\n \"company_physical_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_website\": \"<string>\",\n \"dba\": \"<string>\",\n \"federal_tax_id\": \"<string>\",\n \"industry_type\": \"<string>\",\n \"loan_purpose\": \"<string>\",\n \"monthly_revenue\": 123,\n \"naics\": \"<string>\",\n \"owner_1\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"owner_2\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"predicted_industry_probability\": 123,\n \"source_email_address\": \"<string>\",\n \"source_name\": \"<string>\",\n \"source_notes\": \"<string>\",\n \"state_of_incorporation\": \"<string>\",\n \"type_of_business_entity\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount_requested\": 123,\n \"annual_revenue\": 123,\n \"business_start_date\": \"2023-12-25\",\n \"company_billing_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_email\": \"<string>\",\n \"company_legal_business_name\": \"<string>\",\n \"company_phone_number\": \"<string>\",\n \"company_physical_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"company_website\": \"<string>\",\n \"dba\": \"<string>\",\n \"federal_tax_id\": \"<string>\",\n \"industry_type\": \"<string>\",\n \"loan_purpose\": \"<string>\",\n \"monthly_revenue\": 123,\n \"naics\": \"<string>\",\n \"owner_1\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"owner_2\": {\n \"credit_score\": 123,\n \"date_of_birth\": \"1990-01-01\",\n \"email_address\": \"<string>\",\n \"first_name\": \"<string>\",\n \"has_signed\": true,\n \"home_address\": {\n \"city\": \"<string>\",\n \"line_1\": \"<string>\",\n \"line_2\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"home_phone\": \"<string>\",\n \"last_name\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"ownership_percentage\": 100,\n \"signed_date\": \"2023-12-25\",\n \"social_security_number\": \"<string>\"\n },\n \"predicted_industry_probability\": 123,\n \"source_email_address\": \"<string>\",\n \"source_name\": \"<string>\",\n \"source_notes\": \"<string>\",\n \"state_of_incorporation\": \"<string>\",\n \"type_of_business_entity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "amount_requested": 123,
  "annual_revenue": 123,
  "business_start_date": "2023-12-25",
  "company_billing_address": {
    "city": "<string>",
    "line_1": "<string>",
    "line_2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "company_email": "<string>",
  "company_legal_business_name": "<string>",
  "company_phone_number": "<string>",
  "company_physical_address": {
    "city": "<string>",
    "line_1": "<string>",
    "line_2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "company_website": "<string>",
  "dba": "<string>",
  "federal_tax_id": "<string>",
  "industry_type": "<string>",
  "loan_purpose": "<string>",
  "monthly_revenue": 123,
  "naics": "<string>",
  "owner_1": {
    "credit_score": 123,
    "date_of_birth": "1990-01-01",
    "email_address": "<string>",
    "first_name": "<string>",
    "has_signed": true,
    "home_address": {
      "city": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "home_phone": "<string>",
    "last_name": "<string>",
    "mobile_phone": "<string>",
    "ownership_percentage": 100,
    "signed_date": "2023-12-25",
    "social_security_number": "<string>"
  },
  "owner_2": {
    "credit_score": 123,
    "date_of_birth": "1990-01-01",
    "email_address": "<string>",
    "first_name": "<string>",
    "has_signed": true,
    "home_address": {
      "city": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "home_phone": "<string>",
    "last_name": "<string>",
    "mobile_phone": "<string>",
    "ownership_percentage": 100,
    "signed_date": "2023-12-25",
    "social_security_number": "<string>"
  },
  "predicted_industry_probability": 123,
  "source_email_address": "<string>",
  "source_name": "<string>",
  "source_notes": "<string>",
  "source_type": "iso_application_form",
  "state_of_incorporation": "<string>",
  "type_of_business_entity": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

Body

application/json
amount_requested
number | null
annual_revenue
number | null
business_start_date
string<date> | null
company_billing_address
object
company_email
string | null
company_phone_number
string | null
company_physical_address
object
company_website
string | null
dba
string | null

Doing business as

federal_tax_id
string | null
industry_type
string | null
loan_purpose
string | null
monthly_revenue
number | null
naics
string | null
owner_1
object
owner_2
object
predicted_industry_probability
number | null
source_email_address
string | null
source_name
string | null
source_notes
string | null
state_of_incorporation
string | null
type_of_business_entity
string | null

Response

200 - application/json

OK

amount_requested
number | null
annual_revenue
number | null
business_start_date
string<date> | null
company_billing_address
object
company_email
string | null
company_phone_number
string | null
company_physical_address
object
company_website
string | null
dba
string | null

Doing business as

federal_tax_id
string | null
industry_type
string | null
loan_purpose
string | null
monthly_revenue
number | null
naics
string | null
owner_1
object
owner_2
object
predicted_industry_probability
number | null
source_email_address
string | null
source_name
string | null
source_notes
string | null
source_type
enum<string>

Source of the end user information

Available options:
api,
iso_application_form,
heron_industry_classifier,
rel6_industry_classifier,
email,
end_user_entities
Example:

"iso_application_form"

state_of_incorporation
string | null
type_of_business_entity
string | null