/
HE
herondata
/
Heron Data API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
Analytics
1
AppStore
1
BrokerSubmissions
6
Categories
1
Credentials
5
CrmIntegrations
3
EmailTemplates
3
EndUserAccounts
1
EndUserAttributes
1
EndUserCalculations
18
EndUserDataSourceAccounts
3
EndUserDataSources
3
EndUserEmails
1
EndUserEnrichers
5
EndUserEntity
17
EndUserFiles
22
EndUserFinancials
1
EndUserIntegrations
16
EndUserRules
1
EndUsers
22
get
Get the pinned CLEAR candidate overrides for a background check
post
Pin CLEAR candidate overrides for a background check
delete
Clear all CLEAR candidate overrides for a background check
get
List EndUsers
put
Update EndUser
post
Create EndUser
post
Delete EndUser by heron_id or end_user_id (async)
get
Get EndUser by heron_id or end_user_id
delete
Delete EndUser by heron_id or end_user_id (sync)
get
Download a background check raw report
post
Enrich transactions of EndUser
get
Get duplicate end users for an end user
get
Get EndUser background check dashboard payload
get
Get EndUser emails
get
Get EndUser emails
get
Get EndUser information
patch
Patch EndUser information
get
Get EndUser physical location
get
Get EndUser processing status
get
List EndUsers with Summary Information
get
Retrieve CRM sync events for an end user
post
Trigger a CRM Sync for an End User
EnrichedTransactions
2
EnrichmentFeedback
4
FileClass
4
Funders
3
Integrations
13
ISOApplication
6
Merchants
6
ParsedEndUserSubmission
1
Policy
3
Positions
2
Rules
5
Testing
2
Transactions
4
UserMerchantGroups
1
Users
3
Watermarks
2
Webhooks
5
Workflows
3
post
Add a funder to broker's policies
get
List broker funder policies for current user
patch
Bulk update broker funder policies
get
Export broker funder policies as Excel
get
Get funder submission status
get
Get policy upload job status
get
Get specific policy upload job
get
List funder integration states for the current broker
post
Link a funder to the current broker for self-service
get
List funder policy evaluations for an end user
get
List funders available for self-service that the broker hasn't linked yet
get
List pending funder matches for a job
delete
Remove a funder from broker's policies
put
Save staging or production form values for a funder integration
delete
Remove a funder, or delete one environment's saved integration
patch
Update a funder's submission channel and email configuration
post
Resolve a pending funder match
get
Search funders by name
post
Skip a pending funder match
post
Submit an end user to a single funder
post
Trigger a funder submission
post
Trigger a staging or production test submission for this funder
post
Upload funder policy file for parsing
post
Upsert a funder submission
EndUsers
Get EndUser emails
Get all emails for all end users associate with this user
get
/api/end_user_emails
Query parameters
page
integer
required
limit
integer
required
Response
OK
object
required
_meta
object
emails
object[]
Changes