Authorizations
Body
application/json
Response
201 - application/json
OK
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": "f326175c-f679-4cae-8c23-60232ca99c20",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-09-06T06:17:33.420767",
"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": "f326175c-f679-4cae-8c23-60232ca99c20",
"heron_id": "eus_M42zHXoKF9wQrWtjCpgZDj",
"is_portfolio": true,
"last_processed_at": "2025-10-18T06:17:33.421005",
"last_updated": "2025-10-18T06:17:33.420799",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Create a new end user. If transactions have previously been sent for this end_user_id
, use PUT end_users
to update instead.
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": "f326175c-f679-4cae-8c23-60232ca99c20",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-09-06T06:17:33.420767",
"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": "f326175c-f679-4cae-8c23-60232ca99c20",
"heron_id": "eus_M42zHXoKF9wQrWtjCpgZDj",
"is_portfolio": true,
"last_processed_at": "2025-10-18T06:17:33.421005",
"last_updated": "2025-10-18T06:17:33.420799",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Show child attributes
OK
Show child attributes
Was this page helpful?