List company attributes available for policy checks
Returns the authenticated account’s launch catalogue with picker metadata. Admins get the full internal catalogue, for the account given by user_id or else their current account. An admin impersonating an account also gets the full catalogue for that account.
Authorizations
Query Parameters
Account to inspect. Honoured only for admins.
Response
Ok
Which libraries list this attribute: every customer's, specific customers' only (per-account attributes such as entity fields), or admins' only. Sent only to Heron admins, including while impersonating an account.
all_customers, specific_customers, internal 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
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
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
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"
Presentation metadata for every parameter axis, including its name, description, default value and an option-to-label map. Date axes also carry option_descriptions, an option-to-sentence map saying which dates each option reads. Null for an unparametrised label
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
Settings that change the value's type and unit, e.g. [{"parameters": {"aggregation": "total"}, "type": "decimal", "unit": "currency"}]. Each entry names only the settings that decide the type. A check whose settings include an entry's parameters uses that entry's type and unit; any other check uses the attribute's own. Null when no setting changes it
Which variant of a parametrised label this is, e.g. {"product_type": "mca", "status": "active_only"}. Null for a label that takes no parameters, and null on a catalogue listing, where parameter definitions give the choices instead
The dates a check would read if evaluated today, one entry per combination of its date settings
Where the attribute's value comes from: the business details record, the entity graph, an MCA template entity, one of the account's own (custom) entities, documents, emails, bank statements, transactions, positions, the background check, court records, DataMerch or LendSaaS. Sent only to Heron admins, including while impersonating an account.
business_details, entity_graph, template_entity, custom_entity, documents, emails, bank_statements, transactions, positions, background_check, court_records, datamerch, web_presence, lendsaas, other The picker hierarchy from broad topic to narrow topic.
The value's type, which decides what a check on it can compare: "int", "float", "decimal", "string", "date", "datetime", "bool"
float, int, decimal, string, date, datetime, bool 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
currency, percentage, count, ratio, days, years, text, 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
us_state, naics_industry, naics_code, restricted_industries, merchant, crm_decline_reason, iso_source_name, business_entity_type, null