curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/enrich \
--header 'x-api-key: <api-key>'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-09T21:52:58.632691",
"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": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"is_portfolio": true,
"last_processed_at": "2025-07-21T21:52:58.632901",
"last_updated": "2025-07-21T21:52:58.632720",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Enriches transactions of an end user identified by its end_user_id or heron_id. There is an optional priority
parameter that can be set to high
to prioritize the enrichment over normal
(default) priority. High priority enrichment is only enabled for enterprise-level accounts. Please contact [email protected] to upgrade your account.
curl --request POST \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/enrich \
--header 'x-api-key: <api-key>'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-09T21:52:58.632691",
"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": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"is_portfolio": true,
"last_processed_at": "2025-07-21T21:52:58.632901",
"last_updated": "2025-07-21T21:52:58.632720",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Priority for async enrichment
normal
, high
Ok
The response is of type object
.
Was this page helpful?