Enum Registry
Every closed value set is defined once here, with every value. Fields in the dictionary and parameters in the API reference link to these pages rather than repeating values. Open an enum for its full value set, or see which enums changed between versions on the v2 → v3 changes page.
51 enums · 22 in both schemas · 5 v2 only · 24 v3 only
- The environment a request runs against, given as the {environment} path segment. Test traffic resolves against the same data as live but is not billed.
- Where an HCP appears in a publication's author list.
- Lifecycle status of a bulk enrichment batch.
- Status of an individual item within a bulk enrichment batch.
- Selects which kind of company association a filter targets.
- The kind of link between two companies on a relationship result. This is the response field; the request-side filters are RelationshipType (v2) and RelationshipDirection (v3).
- Estimated employee-count band for a company.
- How a resolved company is legally organized.
- The kind of congress session an HCP presented at, upper-cased from the congress program.
- Status of a contact info batch.
- Status of one item in a contact info batch.
- ISO 3166-1 alpha-2 code of a company's country.
- Lifecycle status of a Deep Match batch.
- How a single Deep Match row resolved.
- Expands the detection window symmetrically when filtering by detection period.
- Deliverability of an enriched email address, ordered by bounce rate. The values are not interchangeable — treat a lower-confidence status as a weaker claim, never as an equivalent one. Statuses come from our enrichment vendor and are passed through unchanged, so a value outside this list can appear if the vendor adds one. Addresses graded INVALID are never returned.
- The most recent funding stage a company has reached.
- The part an HCP played on the medical claims their diagnosis and procedure counts are drawn from. Each role is counted separately and the two are never added together.
- The measure an HCP's conditions treated are ordered by, summed over the requested years.
- A vocabulary the healthcare discover resolve endpoint looks names up in. Each names the request field its IDs go in.
- The measure an HCP's drugs prescribed are ordered by, summed over the requested years. The two are different units and are never added together.
- The healthcare category taxonomy to browse.
- Industry sector for a resolved company, normalized to a controlled list.
- Broad functional classification of a role.
- Coarse job-role classification, serialized as an integer code. Superseded by JobRoleV2.
- Job-role classification (v2).
- Seniority level of a role.
- Fine-grained job sub-role, serialized as an integer code. Superseded by JobSubRoleV2.
- Fine-grained job sub-role classification (v2).
- A prose field the v3 keywords filter can search.
- One of H1's per-indication HCP rankings, upper-cased from its name. Each ranks HCPs in deciles from 1 to 10.
- How FDA licensed a biological product, from the Purple Book. Only products licensed under a BLA carry one.
- A criterion evaluated when matching a person. The ones that fired are reported on the result, and are the evidence its score is computed from.
- How many distinct patients a claims criterion needs over the trailing twelve months.
- Controls whether enrichment may serve cached data or must refresh.
- Reason a person enrichment request could not be fulfilled.
- Filters work experience by whether it is current.
- The outcome of adding one item to a list.
- How a person was added to a list.
- The kind of organization an HCP currently works at, from their current US work affiliations. An HCP carries every setting that applies, and one whose organization is unresolved carries none.
- How a private equity firm invested in a company during one holding period.
- What kind of organization owns a private equity firm.
- The kind of investment firm managing a private equity holding.
- The role the seed companies play in a relationship search; only used when companyFilter=RELATIONSHIP.
- Direction of a company relationship search; only used when companyFilter=RELATIONSHIP. Values name what is returned, not the role of the seed company.
- Estimated annual revenue band for a company.
- How a company's revenue figure was determined.
- How a subsidiary relates to its parent company.
- The part an HCP played on a clinical trial, as recorded on the trial itself.
- A clinical trial's current recruitment status, as of the latest healthcare data delivery.
- Time window over which a product usage signal is aggregated.