Create EndUser

curl --request POST \
  --url https://app.herondata.io/api/end_users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_user": {
    "end_user_id": "b583ca8b-13c9-474f-8eeb-488a6716e128",
    "is_portfolio": true,
    "name": "Company Name Inc.",
    "profit_and_loss_layout": "<unknown>"
  }
}
'

{
  "end_user": {
    "end_user_id": "b583ca8b-13c9-474f-8eeb-488a6716e128",
    "confidence": 0.42,
    "created": "2025-10-15T20:46:06.502685",
    "criteria": [
      {
        "context": "higher_is_better",
        "currency": "<string>",
        "date_range": "last_180_days",
        "description": "The number of unique transactions with a timestamp",
        "group": "data_quality",
        "label": "unique_transactions",
        "status": "not_available",
        "unit": "n",
        "value": 42.42
      }
    ],
    "data_sources": [
      {
        "type": "pdf",
        "status": "new"
      }
    ],
    "heron_id": "eus_EfFhjRsuMDxHCEN5Y2V6PV",
    "is_portfolio": true,
    "last_processed_at": "2025-11-26T20:46:06.502977",
    "last_updated": "2025-11-26T20:46:06.502724",
    "name": "Company Name Inc.",
    "profit_and_loss_layout": "<unknown>",
    "status": "ready"
  }
}

POST

api

end_users

Create EndUser

curl --request POST \
  --url https://app.herondata.io/api/end_users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_user": {
    "end_user_id": "b583ca8b-13c9-474f-8eeb-488a6716e128",
    "is_portfolio": true,
    "name": "Company Name Inc.",
    "profit_and_loss_layout": "<unknown>"
  }
}
'

{
  "end_user": {
    "end_user_id": "b583ca8b-13c9-474f-8eeb-488a6716e128",
    "confidence": 0.42,
    "created": "2025-10-15T20:46:06.502685",
    "criteria": [
      {
        "context": "higher_is_better",
        "currency": "<string>",
        "date_range": "last_180_days",
        "description": "The number of unique transactions with a timestamp",
        "group": "data_quality",
        "label": "unique_transactions",
        "status": "not_available",
        "unit": "n",
        "value": 42.42
      }
    ],
    "data_sources": [
      {
        "type": "pdf",
        "status": "new"
      }
    ],
    "heron_id": "eus_EfFhjRsuMDxHCEN5Y2V6PV",
    "is_portfolio": true,
    "last_processed_at": "2025-11-26T20:46:06.502977",
    "last_updated": "2025-11-26T20:46:06.502724",
    "name": "Company Name Inc.",
    "profit_and_loss_layout": "<unknown>",
    "status": "ready"
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

end_user

object

Show child attributes

end_user.end_user_id

string

required

id defined by user; links to the end_user_id for transactions

Required string length: 1 - 140

Example:

"b583ca8b-13c9-474f-8eeb-488a6716e128"

end_user.is_portfolio

boolean

Whether the end user is part of a lending portfolio

Example:

true

end_user.name

string | null

Name of end user; may help to improve categorisation accuracy

Maximum string length: 128

Example:

"Company Name Inc."

end_user.profit_and_loss_layout

unknown

Response

201 - application/json

end_user

object

Show child attributes

end_user.end_user_id

string

required

id defined by user; links to the end_user_id for transactions

Required string length: 1 - 140

Example:

"b583ca8b-13c9-474f-8eeb-488a6716e128"

end_user.confidence

number

Aggregated confidence for the end user across all transactions; between 0 and 1

Example:

0.42

end_user.created

string<date-time>

When the end user was created in Heron system

Example:

"2025-10-15T20:46:06.502685"

end_user.criteria

object[]

List of scorecard metrics

Show child attributes

end_user.criteria.context

enum<string> | null

Context for how to interpret the metric, e.g., whether a higher value is 'better' than a lower value

Available options:

higher_is_better,

lower_is_better,

Example:

"higher_is_better"

end_user.criteria.currency

string | null

The ISO currency code for metric, where applicable

end_user.criteria.date_range

enum<string>

Metric date range

Available options:

latest,

last_30_days,

last_90_days,

last_120_days,

last_180_days,

last_365_days,

next_30_days,

next_60_days,

next_90_days,

next_180_days,

last_1_calendar_months,

last_3_calendar_months,

last_4_calendar_months,

last_6_calendar_months,

last_12_calendar_months,

last_15_calendar_months,

last_24_calendar_months,

last_1_full_calendar_months,

last_2_full_calendar_months,

last_3_full_calendar_months,

last_6_full_calendar_months,

last_12_full_calendar_months,

last_60_days,

last_45_days,

last_2_calendar_months

Example:

"last_180_days"

end_user.criteria.description

string | null

Description of metric

Example:

"The number of unique transactions with a timestamp"

end_user.criteria.group

enum<string>

The type of metric

Available options:

data_quality,

processing_quality,

balance,

profit_and_loss,

debt,

risk_flag,

forecast,

heron,

ml_feature

Example:

"data_quality"

end_user.criteria.label

string

Metric label, slugified

Example:

"unique_transactions"

end_user.criteria.status

enum<string> | null

either 'calculated' or 'not_available' depending on the requested date range vs. date range of the data

Available options:

available,

partially_available,

not_available,

Example:

"not_available"

end_user.criteria.unit

enum<string>

The unit of measurement for metric

Available options:

n,

day,

ratio,

amount,

weekday,

array,

probability

Example:

"n"

end_user.criteria.value

any | null

The metric value

Example:

42.42

end_user.data_sources

object[]

List of data source summaries for the end user

Show child attributes

end_user.data_sources.type

enum<string>

required

Data source type

Available options:

api,

csv,

pdf,

integration_link,

legacy,

legacy_pdf,

legacy_integration_link

Example:

"pdf"

end_user.data_sources.status

enum<string>

Status of the data source entity, where applicable (e.g. pdfs, integration links)

Available options:

new,

parsing,

parsed,

processed,

human_reviewing,

approved,

rejected,

failed,

transactions_loaded,

transactions_unloaded,

pending,

active,

syncing,

erroring,

sync_disabled,

deleted_in_plaid,

unknown

Example:

"new"

end_user.heron_id

string

Unique id for end user generated by Heron

Example:

"eus_EfFhjRsuMDxHCEN5Y2V6PV"

end_user.is_portfolio

boolean

Whether the end user is part of a lending portfolio

Example:

true

end_user.last_processed_at

string<date-time>

When the end user was last successfully processed in Heron system

Example:

"2025-11-26T20:46:06.502977"

end_user.last_updated

string<date-time>

When the end user was last updated in Heron system

Example:

"2025-11-26T20:46:06.502724"

end_user.name

string | null

Name of end user; may help to improve categorisation accuracy

Maximum string length: 128

Example:

"Company Name Inc."

end_user.profit_and_loss_layout

unknown

end_user.status

enum<string>

Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request

Available options:

new,

ready,

processed,

reviewed,

review_requested,

failed

Example:

"ready"

Update EndUser List EndUsers with Summary Information

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Body

Response