Policy Versions
Publish the draft policy version
Make the draft the active version. The whole draft goes live, including any edits made in the dashboard, not only values set through the API. The previously active version is archived, and author_email becomes the publisher’s email. Refused when a check reads data that no workflow path produces before its section’s policy node.
POST
/
api
/
policy_version
/
publish
Publish the draft policy version
curl --request POST \
--url https://app.herondata.io/api/policy_version/publish \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/policy_version/publish"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/policy_version/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.herondata.io/api/policy_version/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/policy_version/publish"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/policy_version/publish")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policy_version/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"issues": [
{
"blocks_publish": true,
"code": "data_on_no_path",
"message": "<string>",
"path": [
"<unknown>"
],
"attribute_label": "<string>",
"available_after": "<string>",
"check_name": "<string>",
"policy_node_id": "<string>",
"section_heron_id": "<string>",
"section_name": "<string>"
}
],
"policy_version": {
"author_email": "<string>",
"backtest_status": {
"backtest_heron_id": "<string>",
"deal_count": 123,
"finished_at": "2023-11-07T05:31:56Z",
"flipped_deal_count": 123,
"run_status": "pending",
"stale": true
},
"change_description": "<string>",
"created": "2023-11-07T05:31:56Z",
"last_edited_at": "2023-11-07T05:31:56Z",
"policy_definition": {
"policy_sections": [
{
"name": "<string>",
"branches": [
{
"condition": {
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
},
"name": "<string>",
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"heron_id": "<string>"
}
],
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"default_branch": {
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"decline_code": "<string>",
"decline_description": "<string>",
"heron_id": "<string>",
"name": "Default",
"result": "passed"
},
"display_order": 123,
"heron_id": "<string>",
"use_case": "background_check"
}
]
},
"published_at": "2023-11-07T05:31:56Z",
"status": "draft",
"version": 123
}
}{
"description": "<string>",
"errors": [
{
"blocks_publish": true,
"code": "data_on_no_path",
"message": "<string>",
"path": [
"<unknown>"
],
"attribute_label": "<string>",
"available_after": "<string>",
"check_name": "<string>",
"policy_node_id": "<string>",
"section_heron_id": "<string>",
"section_name": "<string>"
}
]
}Was this page helpful?
⌘I
Publish the draft policy version
curl --request POST \
--url https://app.herondata.io/api/policy_version/publish \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/policy_version/publish"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/policy_version/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.herondata.io/api/policy_version/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.herondata.io/api/policy_version/publish"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.herondata.io/api/policy_version/publish")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policy_version/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"issues": [
{
"blocks_publish": true,
"code": "data_on_no_path",
"message": "<string>",
"path": [
"<unknown>"
],
"attribute_label": "<string>",
"available_after": "<string>",
"check_name": "<string>",
"policy_node_id": "<string>",
"section_heron_id": "<string>",
"section_name": "<string>"
}
],
"policy_version": {
"author_email": "<string>",
"backtest_status": {
"backtest_heron_id": "<string>",
"deal_count": 123,
"finished_at": "2023-11-07T05:31:56Z",
"flipped_deal_count": 123,
"run_status": "pending",
"stale": true
},
"change_description": "<string>",
"created": "2023-11-07T05:31:56Z",
"last_edited_at": "2023-11-07T05:31:56Z",
"policy_definition": {
"policy_sections": [
{
"name": "<string>",
"branches": [
{
"condition": {
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
},
"name": "<string>",
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"heron_id": "<string>"
}
],
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"default_branch": {
"checks": [
{
"attribute_description": "<string>",
"attribute_display_name": "<string>",
"attribute_label": "<string>",
"attribute_unit": "currency",
"attribute_value_set": "us_state",
"boolean_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "AND"
},
"date_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "greater_than",
"value": {}
},
"enhanced_sql_check": {
"check_type": "equal",
"column_name": "<string>",
"comparison_value": "<unknown>",
"data_type": "numeric",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"group": "<string>",
"heron_id": "<string>",
"identity": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
},
"parameters": {},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
}
},
"string_check": {
"auto_decline": false,
"decline_code": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"match_count": 123,
"on_failure": "fail",
"pass_description": "<string>",
"transaction_scope": {
"file_classes": [
"<string>"
],
"min_reconciliation_status": "failed"
},
"type": "equal",
"value": "<string>"
}
}
],
"decline_code": "<string>",
"decline_description": "<string>",
"heron_id": "<string>",
"name": "Default",
"result": "passed"
},
"display_order": 123,
"heron_id": "<string>",
"use_case": "background_check"
}
]
},
"published_at": "2023-11-07T05:31:56Z",
"status": "draft",
"version": 123
}
}{
"description": "<string>",
"errors": [
{
"blocks_publish": true,
"code": "data_on_no_path",
"message": "<string>",
"path": [
"<unknown>"
],
"attribute_label": "<string>",
"available_after": "<string>",
"check_name": "<string>",
"policy_node_id": "<string>",
"section_heron_id": "<string>",
"section_name": "<string>"
}
]
}