Skip to main content
GET
List company attributes available for policy checks

Authorizations

x-api-key
string
header
required

Response

Ok

check_options
object[]
required
read-only

Allowed check forms and any conditional inputs for this value type. validators lists the validity operators this variable offers on top of its type's own, e.g. {"type": "is_valid", "label": "must be a valid EIN", "trigger_label": "is invalid"}: type is the operator to store, label reads as the pass condition and trigger_label as the condition that fails the check. Empty when the variable has none. entry_format, on the string_check option, is how each entry of a list value is written: mask has # per digit, any text whose digits fill it is the same entry, saves store it in the mask's form, and any other entry is refused with hint. Null when entries are free text. A string_check entry also carries the variable's operator menu. operators lists the stored operators to offer for a new check, in menu order. legacy_operators lists the rest: a saved check may still hold one, so show it, but do not offer it again. offers_presence is false when the variable always has a value, so the empty-value checks (equal or not_equal with an empty value) should not be offered. pick_only is true when a check may only hold values from the variable's value set. value_set_operators gives the same four fields for each value set a setting can switch the variable to (see parameter_value_sets), and is null when no setting does

enricher
enum<string> | null
required
read-only

The Heron enricher the value comes from. Null when it comes from none.

Available options:
background_check,
court_records,
web_presence,
industry_prediction,
fraud_network,
broker_velocity,
secretary_of_state,
tin_match
library_group
enum<string>
required
read-only

The group the variable library lists this attribute under.

Available options:
bank_statements,
identity,
heron_enrichers,
integrations
parser
string | null
required
read-only

The id of the document parser whose field this is. Null for any other attribute.

source
enum<string>
required
read-only

Where the attribute's value comes from.

Available options:
business_details,
entity_graph,
template_entity,
custom_entity,
documents,
emails,
bank_statements,
transactions,
positions,
background_check,
court_records,
datamerch,
web_presence,
fraud_network,
broker_velocity,
industry_prediction,
lendsaas,
other
sources
enum<string>[]
required
read-only

For an attribute that compares several sources, those sources. Empty for any other attribute.

Available options:
background_check,
bank_statements,
broker_velocity,
court_records,
fraud_network,
industry_prediction,
secretary_of_state,
tin_match,
web_presence
availability
enum<string>
read-only

Which libraries list this attribute: every customer's, or specific customers' only (per-account attributes such as entity fields). Not included in customer responses.

Available options:
all_customers,
specific_customers,
internal
description
string | null
read-only

What the value means, written for the customer reading their own rules - the status words a position count admits, what a window is anchored to, when the value is missing rather than zero. Null for a label with no curated description yet. Present only for accounts on policy versions

display_name
string
read-only

The attribute's human-readable name, with its tier as a qualifier, e.g. "NSF days last 30 days", "Open judgment total amount (12 months, background check, owner 1)". Parameters are not part of the name - render them from parameters where the context wants them. Derived, so it may be reworded. Present only for accounts on policy versions

label
string

The attribute's stable identifier, which a check refers to and a CRM field maps onto. Namespaced with ":" where a source groups its attributes, e.g. "nsf_days_last_30_days", "BackgroundCheck:owner_1:has_felony"

minimum
integer | null
read-only

The lowest threshold a numeric check on this attribute may compare with; a save refuses a lower one. 0 for a percentage, ratio, count or number of days. Null when the value can be negative, such as money

parameter_definitions
any
read-only

Presentation metadata for every parameter axis, including its name, description, default value, an option-to-label map and option_descriptions, an option-to-sentence map saying what choosing each option does, and tier: regular for a setting rule authors often tune, advanced for one they rarely change, which the editor can tuck away. kind is choice for a setting that takes one of its options, or number for one that takes any whole number from minimum up, with its options as suggested values. multiple: true marks a setting that takes one option or a list of several. shown_when, e.g. {"filter_by": ["merchant_group"]}, marks a setting that applies only while each named setting holds one of the listed options; the editor hides it otherwise. Null for an unparametrised label

parameter_value_sets
any
read-only

Settings that change the vocabulary the value is drawn from, e.g. [{"parameters": {"address": "physical", "part": "state"}, "value_set": "us_state"}]. A check whose settings match an entry uses that entry's value_set; any other check uses the attribute's own value_set. Null when no setting changes it

parameter_value_types
object[] | null
read-only

Settings that change the value's type and unit, e.g. [{"parameters": {"aggregation": "total"}, "type": "decimal", "unit": "currency", "minimum": null}]. Each entry names only the settings that decide the type. A check whose settings include an entry's parameters uses that entry's type, unit and minimum; any other check uses the attribute's own. Null when no setting changes it

parameters
object | null

Which variant of a parametrised label this is, e.g. {"product_type": "mca", "status": "active_only"}. A setting marked multiple in its parameter definition may hold a list of options. Null for a label that takes no parameters, and null on a catalogue listing, where parameter definitions give the choices instead

period_examples
any
read-only

Preview only, never part of a description: the dates a check would read if evaluated today, one entry per combination of its date settings

topic_path
string[]
read-only

The picker hierarchy from broad topic to narrow topic.

type
enum<string>

The value's type, which decides what a check on it can compare: "int", "float", "decimal", "string", "date", "datetime", "bool"

Available options:
float,
int,
decimal,
string,
date,
datetime,
bool
unit
any | null

How to format the value, which type alone cannot say: "currency" (in the deal's currency), "percentage" (already in percent points), "count", "ratio" (a 0-1 quotient), "days", "text". Null for an attribute with no declared unit - print the raw value

Available options:
currency,
percentage,
count,
ratio,
days,
years,
text,
null
value_set
any | null

The finite vocabulary the value is drawn from, so the editor can offer a dropdown instead of free text. Keys into the /policy_value_sets response. Null for free text

Available options:
us_state,
naics_industry,
naics_code,
restricted_industries,
merchant,
crm_decline_reason,
iso_source_name,
business_entity_type,
fraud_network_finding,
broker_velocity,
broker_velocity_signal,
fraud_network_scan_status,
fraud_network_classification,
industry_category,
datamerch_note_category,
complete_months,
null