curl --request PUT \
--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": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<unknown>",
"status": "ready"
}
}
'{
"end_user": {
"end_user_id": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"confidence": 0.42,
"created": "2025-10-31T10:00:53.619165",
"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_7LXGsUNgVvLQBdN6AriatL",
"is_portfolio": true,
"last_processed_at": "2025-12-12T10:00:53.619655",
"last_updated": "2025-12-12T10:00:53.619229",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<unknown>",
"status": "ready"
}
}Confirm an end user is ready for async processing by sending a status of “ready”. The end_user_id must have previously been sent with at least one Transaction if attempting to update the status.
curl --request PUT \
--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": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<unknown>",
"status": "ready"
}
}
'{
"end_user": {
"end_user_id": "392bb4b9-189b-4d26-9307-c8c59ddad61d",
"confidence": 0.42,
"created": "2025-10-31T10:00:53.619165",
"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_7LXGsUNgVvLQBdN6AriatL",
"is_portfolio": true,
"last_processed_at": "2025-12-12T10:00:53.619655",
"last_updated": "2025-12-12T10:00:53.619229",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<unknown>",
"status": "ready"
}
}Was this page helpful?