v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUsers

Create EndUser

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 body

Example request

{
  "end_user": {
    "confidence": 0.42,
    "created": "2026-06-11T19:53:47.159649",
    "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": "1b856eb2-8510-47d9-9025-c1bd7eb5eae4",
    "heron_id": "eus_WAcrEUnGkmMjYoRJBRbpwc",
    "is_portfolio": true,
    "last_processed_at": "2026-07-23T19:53:47.159954",
    "last_updated": "2026-07-23T19:53:47.159683",
    "name": "Company Name Inc."
  }
}

Response

Example response

{
  "end_user": {
    "confidence": 0.42,
    "created": "2026-06-11T19:53:47.159649",
    "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": "1b856eb2-8510-47d9-9025-c1bd7eb5eae4",
    "heron_id": "eus_WAcrEUnGkmMjYoRJBRbpwc",
    "is_portfolio": true,
    "last_processed_at": "2026-07-23T19:53:47.159954",
    "last_updated": "2026-07-23T19:53:47.159683",
    "name": "Company Name Inc.",
    "status": "ready"
  }
}