Guide

Codes & enums

View as markdown Open in ChatGPT Open in Claude

Closed vocabularies used across /v3 responses. Values may be added in a minor version. Within a major version no value is removed or redefined. Tolerate values you do not recognise.

Resolution status

matched
partial_match
inconclusive
no_match
not_found
pending
merged

Entity status

null when unknown.

active
inactive

Enrichment status

On enrichment.status, and on the top-level status of a domain lookup.

pending
building
refreshing
complete
failed

Entity type

type

business
nonprofit
government
person
other
unknown

subtype

incorporated_entity
unincorporated_entity
nonprofit_entity
government_entity
natural_person
complex_business_structure
trading_name_only
other_entity
unknown

facets describes ownership and legal form, not industry. Industry codes live under industry.schemes.

sector

private
public
government
nonprofit

legal_form. corporation is the generic incorporated form. c_corp and s_corp are used only when a source states the election explicitly.

llc
corporation
c_corp
s_corp
lp
llp
gp
sole_proprietorship
nonprofit_corp
pllc
pc
cooperative
municipal_agency
government_entity
trust
unknown

Business model axes

On classification, ordered most-material-first. Index 0 is the dominant value, so group on it rather than exploding the array. [] means undetermined. market_segments returns at most two values and revenue_models at most three. b2b2c is never returned alongside b2b or b2c. Both axes describe the resource that returns them: a domain describes that domain's motion, an entity describes the whole company.

market_segments

b2b
b2c
b2g
b2b2c

revenue_models

subscription
usage_based
transaction_fee
marketplace
product_sales
services
advertising
licensing
lending_and_deposits
insurance_premium
leasing_rental
grants_donations

Industry schemes

industry.schemes is keyed by scheme: naics_2022 and sic. A scheme that was not classified is absent, and an empty key is never returned. Within a scheme, the primary code comes first.

Identifier types

Returned in this order, canonicalized per type.

Type	Format
`registration_id`	As issued by the registry, with the issuing `jurisdiction`
`cik`	Zero-padded to 10 digits
`lei`	20 alphanumerics
`bic`	8 or 11 characters
`ein`	`##-#######`
`duns`	9 bare digits
`ticker`	Uppercase symbol

Basis provenance

With include=basis, each entry's confidence is high, medium or low, and every citation carries a source_type and an authority_tier.

`source_type`	`authority_tier`
`government_registry`	1
`public_profile`	2
`company_website`	3
`web`	3

Factor codes

factors[] entries have a type of strength or limitation and a stable code. Each entry also carries its own description and impact, so you rarely need to map codes yourself. other is the escape hatch on both lists.

Strengths

name_exact_match
name_close_match
location_confirmed
jurisdiction_match
industry_match
registration_number_match
multiple_sources_corroboration
legal_entity_confirmed
headquarters_match
foreign_branch_match
branch_vs_subsidiary_clarity
legal_registration_verified
registry_identifier_anchored
legal_entity_confirmed_on_website
domain_content_matches_entity
consistent_entity_references
current_ownership_verified
website_official_status
authoritative_legal_documentation

Limitations

no_location_provided
location_mismatch
multiple_potential_entities
name_too_generic
name_mismatch
numeric_identifier_only
insufficient_data
max_iterations_reached
no_legal_entity_confirmed
unsupported_entity_type
limited_entity_type_support
parent_entity_confusion
jurisdiction_mismatch
no_branch_registration_found
separate_legal_entities
product_vs_company
brand_vs_legal_entity_confusion
no_legal_entity_on_website
limited_domain_information
multiple_entities_mentioned
domain_ownership_changed
conflicting_ownership_info
domain_parked_or_inactive
entity_merged_redirect
reasoning_degraded

Action codes

actions[] suggests how to sharpen an ambiguous query.

add_location
clarify_name
provide_full_legal_name
specify_entity_relationship
specify_identifier_type
include_industry_context
search_for_parent_company
include_entity_name
add_jurisdiction

Domain context

domain_type

corporate_website
infrastructure
service_platform
email_domain
api_endpoint
cdn_domain
subdomain
parked_domain
personal_site
content_platform
placeholder_page
non_business
other

domain_relationship

direct_owner
parent_company
infrastructure_provider
service_provider
email_provider
platform_provider