HEherondata
EndUsers

Create EndUser

Changed on

Create a new end user. If transactions have previously been sent for this end_user_id, use PUT end_users to update instead.

post/api/end_users

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_users
  • Auth
    API key in header x-api-key

Request body

Example request

{
  "end_user": {
    "confidence": 0.42,
    "created": "2026-09-22T13:48:17.145047",
    "criteria": [
      {
        "context": "higher_is_better",
        "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": [
      {
        "status": "new",
        "type": "pdf"
      }
    ],
    "end_user_id": "8dc2ffc4-b5b2-4daa-9912-f2b05a4c8b1e",
    "heron_id": "eus_W2yb7hSzruhnvUKW2ysUs8",
    "is_portfolio": true,
    "last_processed_at": "2026-11-03T13:48:17.145471",
    "last_updated": "2026-11-03T13:48:17.145083",
    "name": "Company Name Inc."
  }
}

Response

OK

Example response

{
  "end_user": {
    "confidence": 0.42,
    "created": "2026-09-22T13:48:17.145047",
    "criteria": [
      {
        "context": "higher_is_better",
        "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": [
      {
        "status": "new",
        "type": "pdf"
      }
    ],
    "end_user_id": "8dc2ffc4-b5b2-4daa-9912-f2b05a4c8b1e",
    "heron_id": "eus_W2yb7hSzruhnvUKW2ysUs8",
    "is_portfolio": true,
    "last_processed_at": "2026-11-03T13:48:17.145471",
    "last_updated": "2026-11-03T13:48:17.145083",
    "name": "Company Name Inc.",
    "status": "ready"
  }
}

Changes

  • bd8008e49534Revision changes
    • info

      added the new optional request property /

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status