EndUsers
Get EndUser information
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
EndUserFiles
- GETAll EndUserFiles
- GETGet all file classes
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser industry
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
EndUsers
Get EndUser information
Get the company details of an end user including loan information
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
end_user_information
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information \
--header 'Authorization: Basic <encoded-value>'
{
"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
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Response
200 - application/json
OK
Doing business as
Example:
"1990-01-01"
Percentage of ownership
Example:
100
Example:
"1990-01-01"
Percentage of ownership
Example:
100
Source of the end user information
Available options:
api
, iso_application_form
, heron_industry_classifier
, rel6_industry_classifier
, email
Example:
"iso_application_form"
Was this page helpful?
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/end_user_information \
--header 'Authorization: Basic <encoded-value>'
{
"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>"
}