HEherondata
BrokerSubmissions

Add details to broker submission

Changed on

Add company and owner details to existing broker submission. Authentication: Requires a broker API key in the x-api-key header. Generate keys using the /api/broker_submissions/api_keys/generate endpoint.

post/api/broker_submissions/{submission_heron_id}/update_information

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/broker_submissions/{submission_heron_id}/update_information
  • Auth
    API key in header x-api-key

Path parameters

submission_heron_idstring required

Request body

amount_requestednumber nullable
annual_revenuenumber nullable
business_start_datestring date nullable
company_emailstring nullable
company_legal_business_namestring nullable
company_phone_numberstring nullable
company_websitestring nullable
dbastring nullable

Doing business as

federal_tax_idstring nullable
industry_typestring nullable
loan_purposestring nullable
monthly_revenuenumber nullable
naicsstring nullable
predicted_industry_probabilitynumber nullable
source_email_addressstring nullable
source_namestring nullable
source_notesstring nullable
state_of_incorporationstring nullable
type_of_business_entitystring nullable

Example request

{
  "owner_1": {
    "date_of_birth": "1990-01-01",
    "ownership_percentage": 100,
    "prefix": "Mr",
    "suffix": "Jr"
  },
  "owner_2": {
    "date_of_birth": "1990-01-01",
    "ownership_percentage": 100,
    "prefix": "Mr",
    "suffix": "Jr"
  }
}

Response

OK

amount_requestednumber nullable
annual_revenuenumber nullable
business_start_datestring date nullable
company_emailstring nullable
company_legal_business_namestring nullable
company_phone_numberstring nullable
company_websitestring nullable
dbastring nullable

Doing business as

federal_tax_idstring nullable
industry_typestring nullable
loan_purposestring nullable
monthly_revenuenumber nullable
naicsstring nullable
predicted_industry_probabilitynumber nullable
source_email_addressstring nullable
source_namestring nullable
source_notesstring nullable
source_type'api' | 'iso_application_form' | 'heron_industry_classifier' | 'rel6_industry_classifier' | 'email' | 'end_user_entities'

Source of the end user information

state_of_incorporationstring nullable
type_of_business_entitystring nullable

Example response

{
  "owner_1": {
    "date_of_birth": "1990-01-01",
    "ownership_percentage": 100,
    "prefix": "Mr",
    "suffix": "Jr"
  },
  "owner_2": {
    "date_of_birth": "1990-01-01",
    "ownership_percentage": 100,
    "prefix": "Mr",
    "suffix": "Jr"
  },
  "source_type": "iso_application_form"
}

Changes

  • bd8008e49534Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status