Heron End Users API
The End Users API from Heron — 3 operation(s) for end users.
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_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
#
POST
/api/end_users/{end_user_id_or_heron_id}/delete
Delete EndUser by heron_id or end_user_id (async)
#
Documentation
Documentation
https://docs.herondata.io/
APIReference
https://docs.herondata.io/api-reference/authentication
GettingStarted
https://docs.herondata.io/
Authentication
https://artifacts.apis.io/heron/authentication/heron-authentication.yml
Specifications
OpenAPI
https://artifacts.apis.io/heron/openapi/heron-end-users-api-openapi.yml
AsyncAPI
https://artifacts.apis.io/heron/asyncapi/heron-webhooks-asyncapi.yml