Skip to main content
POST
/
api
/
broker_submissions
/
{submission_heron_id}
/
update_information
Add details to broker submission
curl --request POST \
  --url https://app.herondata.io/api/broker_submissions/{submission_heron_id}/update_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>"
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
submission_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_legal_business_name
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_legal_business_name
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