Heron

Heron End Users API

The End Users API from Heron — 3 operation(s) for end users.

GitHub OpenAPI

Operations 30

GET /api/end_users/{end_user_heron_id}/funder_policy_evaluations/ List funder policy evaluations for an end user #
POST /api/end_users/{end_user_heron_id}/funder_submissions/{submission_heron_id}/submit_to_funder/ Submit an end user to a single funder #
GET /api/end_user_emails Get EndUser emails #
GET /api/end_users List EndUsers #
POST /api/end_users Create EndUser #
PUT /api/end_users Update EndUser #
GET /api/end_users/summary List EndUsers with Summary Information #
GET /api/end_users/{end_user_heron_id}/background_check Get EndUser background check dashboard payload #
GET /api/end_users/{end_user_heron_id}/background_check/affiliations List an end user's background check affiliations #
POST /api/end_users/{end_user_heron_id}/background_check/affiliations/reports Request background check reports for affiliations #
POST /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/confirm Confirm a candidate for an affiliate report #
DELETE /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/{ref} Stop tracking an affiliate report #
DELETE /api/end_users/{end_user_heron_id}/background_check/override Clear all CLEAR candidate overrides for a background check #
GET /api/end_users/{end_user_heron_id}/background_check/override Get the pinned CLEAR candidate overrides for a background check #
POST /api/end_users/{end_user_heron_id}/background_check/override Pin CLEAR candidate overrides for a background check #
GET /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/raw_report Download a background check raw report #
GET /api/end_users/{end_user_heron_id}/background_check/subjects/{subject_key}/records/{record_id}/mugshot View a criminal-record mug shot #
GET /api/end_users/{end_user_heron_id}/duplicate_end_users Get duplicate end users for an end user #
DELETE /api/end_users/{end_user_id_or_heron_id} Delete EndUser by heron_id or end_user_id (sync) #
GET /api/end_users/{end_user_id_or_heron_id} Get EndUser by heron_id or end_user_id #
POST /api/end_users/{end_user_id_or_heron_id}/delete Delete EndUser by heron_id or end_user_id (async) #
GET /api/end_users/{end_user_id_or_heron_id}/emails Get EndUser emails #
GET /api/end_users/{end_user_id_or_heron_id}/end_user_information Get EndUser information #
PATCH /api/end_users/{end_user_id_or_heron_id}/end_user_information Patch EndUser information #
POST /api/end_users/{end_user_id_or_heron_id}/enrich Enrich transactions of EndUser #
GET /api/end_users/{end_user_id_or_heron_id}/location Get EndUser physical location #
GET /api/end_users/{end_user_id_or_heron_id}/processing_status Get EndUser processing status #
GET /api/end_users/{heron_id}/crm_sync Retrieve CRM sync events for an end user #
POST /api/end_users/{heron_id}/crm_sync Trigger a CRM Sync for an End User #

Documentation

📖
Documentation
https://docs.herondata.io/
📖
APIReference
https://docs.herondata.io/api-reference/authentication
📖
GettingStarted
https://docs.herondata.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/authentication/heron-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-end-users-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/llms/heron-llms.txt
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/asyncapi/heron-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heron:heron-end-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

heron-end-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data End Users API
  version: '2021-07-19'
servers:
- description: Production
  url: https://app.herondata.io
security:
- ApiKeyAuth:
  - key_XXX
tags:


# --- truncated at 32 KB (217 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/heron/refs/heads/main/openapi/heron-end-users-api-openapi.yml