POST
/
api
/
end_users
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": {
    "crm_sync_result": {
      "crm_record_url": "<string>",
      "error_message": "<string>",
      "heron_id": "<string>",
      "name": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "provider": "<string>",
      "result": "success"
    },
    "end_user_id": "e5969dfd-160d-4d0f-8e71-a0c219cebd78",
    "files": [
      {
        "file_class": "<string>",
        "filename": "<string>",
        "heron_id": "<string>",
        "renamed_filename": "<string>"
      }
    ],
    "is_portfolio": true,
    "name": "Company Name Inc.",
    "policy_evaluations": [
      "passed"
    ],
    "profit_and_loss_layout": "<any>"
  }
}'
{
  "end_user": {
    "confidence": 0.42,
    "created": "2025-03-19T19:15:20.363128",
    "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": "e5969dfd-160d-4d0f-8e71-a0c219cebd78",
    "heron_id": "eus_2PbzLP3BSwiWSCdeaKmSUT",
    "is_portfolio": true,
    "last_processed_at": "2025-04-30T19:15:20.363340",
    "last_updated": "2025-04-30T19:15:20.363156",
    "name": "Company Name Inc.",
    "profit_and_loss_layout": "<any>",
    "status": "ready"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json

Response

201 - application/json
OK

The response is of type object.