My Developer Portal
LaborLens API

Schemas


SearchRequest

  • startinteger | null
  • querystring | null
  • sponsor_idsstring[]
  • industriesstring[]
  • min_total_participantsinteger | null
  • max_total_participantsinteger | null
  • min_active_participantsinteger | null
  • max_active_participantsinteger | null

SearchHit

  • sponsor_idstring · required

    Unique identifier for the plan sponsor

  • industry_level_1string | null

    Top-level industry classification (e.g., 'Agriculture, Forestry, Fishing and Hunting')

  • industry_level_2string | null

    Second-level industry classification (e.g., 'Animal Production')

  • industry_level_3string | null

    Most specific industry classification (e.g., 'Cattle Feedlots')

  • sponsor_max_filing_datestring | null

    Most recent filing date for this sponsor (ISO 8601 date format)

  • sponsor_namestring | null

    Official name of the sponsoring company or organization

  • sponsor_einstring | null

    Employer Identification Number (EIN) of the sponsor

  • sponsor_address_1string | null

    Primary address line of the sponsor's headquarters

  • sponsor_address_2string | null

    Secondary address line (suite, floor, etc.) of the sponsor's headquarters

  • sponsor_citystring | null

    City where the sponsor is headquartered

  • sponsor_statestring | null

    State or province where the sponsor is headquartered

  • sponsor_countrystring | null

    Country where the sponsor is headquartered

  • sponsor_business_codestring | null

    Business classification code for the sponsor's primary business activity

  • sponsor_phone_numberstring | null

    Primary contact phone number for the sponsor

  • total_participants_end_of_yearinteger | null

    Total number of participants in all plans at the end of the reporting year

  • active_participants_end_of_yearinteger | null

    Number of active participants in all plans at the end of the reporting year

  • tot_assets_eoy_amtnumber | null

    Total assets amount across all plans at the end of the reporting year (in USD)

  • tot_income_amtnumber | null

    Total income amount across all plans for the reporting year (in USD)

SearchResponse

  • countinteger
  • resultsobject[]

Industry

  • codestring · required

    Unique numerical identifier for the industry classification

  • industry_level_onestring · required

    Top-level industry sector (e.g., 'Agriculture, Forestry, Fishing and Hunting')

  • industry_level_twostring · required

    Second-level industry group within the sector (e.g., 'Animal Production')

  • industry_level_threestring · required

    Most specific industry classification (e.g., 'Cattle Feedlots')

  • idstring · required

    Unique identifier for the sponsor (UUID format)

  • namestring · required

    Official name of the sponsoring company or organization

  • einstring · required

    Employer Identification Number (EIN) of the sponsor

  • business_codestring · required

    Business classification code for the sponsor's primary business activity

  • address1string · required

    Primary address line of the sponsor's headquarters

  • citystring · required

    City where the sponsor is headquartered

  • statestring · required

    State or province where the sponsor is headquartered

  • postal_codestring · required

    ZIP or postal code for the sponsor's headquarters

  • countrystring · required

    Country where the sponsor is headquartered

  • created_atstring · date-time · required

    Timestamp when the sponsor record was created (ISO 8601 format)

  • updated_atstring · date-time · required

    Timestamp when the sponsor record was last updated (ISO 8601 format)

  • sectorstring · required

    Top-level industry sector classification

  • industrystring · required

    Second-level industry group classification

  • subindustrystring · required

    Most specific industry classification

  • address2string | null

    Secondary address line (suite, floor, etc.) of the sponsor's headquarters

  • peersstring[]

    List of peer/competitor sponsor IDs in the same industry or sector

Plan

  • idstring · required

    Unique identifier for the plan (UUID format)

  • namestring · required

    Official name of the employee benefit plan

  • numstring · required

    Plan number assigned by the sponsor (typically 3-digit identifier)

  • einstring · required

    Employer Identification Number (EIN) of the plan sponsor

  • effective_datestring · date · required

    Date when the plan became effective (ISO 8601 date format)

  • category_idstring · required

    Identifier for the plan category classification

  • type_idstring · required

    Identifier for the specific plan type

  • max_filing_datestring · date · required

    Most recent filing date for this plan (ISO 8601 date format)

  • benefit_codesstring[] · required

    Array of benefit codes indicating the types of benefits offered by the plan

  • created_atstring · date-time · required

    Timestamp when the plan record was created (ISO 8601 format)

  • updated_atstring · date-time · required

    Timestamp when the plan record was last updated (ISO 8601 format)

Broker

  • row_orderinteger · required

    Order of the broker in the list

  • namestring · required

    Name of the broker

  • address1string · required

    Primary address line of the broker

  • citystring · required

    City where the broker is located

  • statestring · required

    State where the broker is located

  • postal_codestring · required

    Postal code for the broker's address

  • commission_paidnumber · required

    Total commission paid to the broker

  • broker_codestring · required

    Broker code

  • address2string | null

    Secondary address line of the broker

  • fees_paidnumber | null

    Total fees paid to the broker

  • fees_paid_textstring | null

    Text description of fees paid

Carrier

  • form_idinteger · required

    Form identifier for the insurance contract

  • carrier_namestring · required

    Name of the insurance carrier

  • carrier_einstring · required

    Employer Identification Number (EIN) of the carrier

  • naic_codestring · required

    NAIC code for the insurance carrier

  • contract_numberstring · required

    Contract or policy number

  • persons_covered_eoyinteger · required

    Number of persons covered at end of year

  • policy_from_datestring · date · required

    Policy effective start date (ISO 8601 format)

  • policy_to_datestring · date · required

    Policy effective end date (ISO 8601 format)

  • broker_commission_totalnumber · required

    Total broker commission paid

  • broker_fees_totalnumber · required

    Total broker fees paid

  • welfare_total_charges_paidnumber · required

    Total welfare charges paid

  • brokersobject[]

    List of brokers associated with this carrier

Filing

  • sponsor_namestring · required

    Official name of the plan sponsor

  • sponsor_einstring · required

    Employer Identification Number (EIN) of the sponsor

  • sponsor_phone_numberstring · required

    Primary contact phone number for the sponsor

  • sponsor_business_codestring · required

    Business classification code for the sponsor's primary business activity

  • sponsor_address1string · required

    Primary address line of the sponsor's headquarters

  • sponsor_citystring · required

    City where the sponsor is headquartered

  • sponsor_statestring · required

    State or province where the sponsor is headquartered

  • sponsor_postal_codestring · required

    ZIP or postal code for the sponsor's headquarters

  • sponsor_countrystring · required

    Country where the sponsor is headquartered

  • ack_idstring · required

    Unique acknowledgment ID for the filing submission

  • form_yearinteger · required

    Year for which the form is being filed

  • cy_fy_begin_datestring · date · required

    Beginning date of the plan year covered by this filing (ISO 8601 date format)

  • cy_fy_end_datestring · date · required

    End date of the plan year covered by this filing (ISO 8601 date format)

  • plan_namestring · required

    Official name of the employee benefit plan

  • plan_numstring · required

    Plan number assigned by the sponsor (typically 3-digit identifier)

  • plan_effective_datestring · date · required

    Date when the plan became effective (ISO 8601 date format)

  • pension_benefit_codesstring[] · required

    Array of pension benefit codes indicating the types of pension benefits offered

  • date_receivedstring · date · required

    Date when the filing was received by the regulatory authority (ISO 8601 date format)

  • total_participants_beginning_of_yearinteger · required

    Total number of participants at the beginning of the plan year

  • total_participants_end_of_yearinteger · required

    Total number of participants at the end of the plan year

  • participants_with_account_balances_end_of_yearinteger · required

    Number of participants with account balances at the end of the plan year

  • active_participants_beginning_of_yearinteger · required

    Number of active participants at the beginning of the plan year

  • active_participants_end_of_yearinteger · required

    Number of active participants at the end of the plan year

  • participants_teminated_before_vestinginteger · required

    Number of participants who terminated before vesting

  • type_plan_entity_cdstring · required

    Code indicating the type of plan entity

  • tot_assets_boy_amtnumber · required

    Total assets at the beginning of the year (in USD)

  • tot_assets_eoy_amtnumber · required

    Total assets at the end of the year (in USD)

  • tot_liabilities_boy_amtnumber · required

    Total liabilities at the beginning of the year (in USD)

  • tot_liabilities_eoy_amtnumber · required

    Total liabilities at the end of the year (in USD)

  • net_assets_boy_amtnumber · required

    Net assets at the beginning of the year (in USD)

  • net_assets_eoy_amtnumber · required

    Net assets at the end of the year (in USD)

  • emplr_contrib_income_amtnumber · required

    Employer contribution income amount for the plan year (in USD)

  • particip_contrib_income_amtnumber · required

    Participant contribution income amount for the plan year (in USD)

  • oth_contrib_rcvd_amtnumber · required

    Other contributions received amount for the plan year (in USD)

  • other_income_amtnumber · required

    Other income amount for the plan year (in USD)

  • tot_income_amtnumber · required

    Total income amount for the plan year (in USD)

  • tot_distrib_bnft_amtnumber · required

    Total distribution benefit amount for the plan year (in USD)

  • corrective_deemed_distr_amtnumber · required

    Corrective deemed distribution amount for the plan year (in USD)

  • admin_srvc_providers_amtnumber · required

    Administrative service providers amount for the plan year (in USD)

  • oth_expenses_amtnumber · required

    Other expenses amount for the plan year (in USD)

  • tot_expenses_amtnumber · required

    Total expenses amount for the plan year (in USD)

  • net_income_amtnumber · required

    Net income amount for the plan year (in USD)

  • tot_plan_transfers_amtnumber · required

    Total plan transfers amount for the plan year (in USD)

  • created_atstring · date-time · required

    Timestamp when the filing record was created (ISO 8601 format)

  • updated_atstring · date-time · required

    Timestamp when the filing record was last updated (ISO 8601 format)

  • last_reported_sponsor_namestring | null

    Previously reported sponsor name if different from current

  • last_reported_sponsor_einstring | null

    Previously reported sponsor EIN if different from current

  • sponsor_address2string | null

    Secondary address line (suite, floor, etc.) of the sponsor's headquarters

  • last_reported_plan_namestring | null

    Previously reported plan name if different from current

  • last_reported_plan_numberstring | null

    Previously reported plan number if different from current

  • welfare_benefit_codesarray | null

    Array of welfare benefit codes indicating the types of welfare benefits offered

  • broker_fees_paidnumber | null

    Amount of broker fees paid during the plan year (in USD)

  • insuranceobject[]

Error

  • messagestring · required

    Human-readable error message describing what went wrong

  • status_codeinteger · enum · required

    HTTP status code indicating the type of error

    Enum values:
    400
    500
  • sponsorobject
  • plansobject[]

RateLimit

  • typestring · required

    URI reference that identifies the problem type

  • titlestring · required

    Short, human-readable summary of the problem type

  • statusinteger · required

    HTTP status code for this occurrence of the problem

  • instancestring · required

    URI reference that identifies the specific occurrence of the problem

  • traceobject · required

    Debugging and tracing information for the request