HEherondata
Policy

List company attributes available for policy checks

Changed on

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.

get/api/company_attributes

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/company_attributes
  • Auth
    API key in header x-api-key

Query parameters

user_idinteger

Account to inspect. Honoured only for admins.

Response

Ok

availability'all_customers' | 'specific_customers' | 'internal'

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.

descriptionstring nullable

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_namestring

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

labelstring

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"

parameter_definitionsunknown
parameter_value_setsunknown
parametersobject nullable

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

period_examplesunknown
source'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'

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.

topic_pathstring[]

The picker hierarchy from broad topic to narrow topic.

type'float' | 'int' | 'decimal' | 'string' | 'date' | 'datetime' | 'bool'

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

unitunknown
value_setunknown

Changes

  • 1ec936e17fefRevision changes
    • warning

      added the new industry_category enum value to the / response property for the response status

    • warning

      added the new industry_prediction enum value to the / response property for the response status

  • bd8008e49534Revision changes
    • info

      endpoint added