Policy
Get the policy evaluations for an end user
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
EndUserFiles
- GETAll EndUserFiles
- GETGet all file classes
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser industry
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
Policy
Get the policy evaluations for an end user
Evaluates the user’s policies against end user on-the-fly
GET
/
api
/
end_users
/
{heron_id}
/
policy_evaluations
curl --request GET \
--url https://app.herondata.io/api/end_users/{heron_id}/policy_evaluations \
--header 'Authorization: Basic <encoded-value>'[
{
"failed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"missing_data_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"passed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"policy": {
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
}
],
"display_order": null,
"heron_id": "<string>",
"name": "<string>"
},
"result": "passed"
}
]Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Response
200 - application/json
Ok
Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on failed_checks.evaluations.check.date_delta_to_now_check.ignore_metric_availability
boolean
default:false
Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in missing_data_checks.evaluations.check.boolean_check.ignore_metric_availability
boolean
default:false
missing_data_checks.evaluations.check.composite_check.ignore_metric_availability
boolean
default:false
Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on missing_data_checks.evaluations.check.date_delta_to_now_check.ignore_metric_availability
boolean
default:false
Available options:
greater_than, less_than missing_data_checks.evaluations.check.numeric_check.ignore_metric_availability
boolean
default:false
Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal missing_data_checks.evaluations.check.string_check.ignore_metric_availability
boolean
default:false
Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on passed_checks.evaluations.check.date_delta_to_now_check.ignore_metric_availability
boolean
default:false
Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
pass, failed, missing_data Available options:
AND, OR Available options:
equal, not_equal, before, before_or_on, after, after_or_on Available options:
greater_than, less_than Available options:
equal, not_equal, greater_than, greater_than_or_equal, less_than, less_than_or_equal Available options:
equal, not_equal, contains, does_not_start_with, does_not_contain, is_in, is_not_in Available options:
passed, failed, missing_data Was this page helpful?
curl --request GET \
--url https://app.herondata.io/api/end_users/{heron_id}/policy_evaluations \
--header 'Authorization: Basic <encoded-value>'[
{
"failed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"missing_data_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"passed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"policy": {
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
}
],
"display_order": null,
"heron_id": "<string>",
"name": "<string>"
},
"result": "passed"
}
]