Getting Classifications
Get a list of industries to classify an applicant.
Today, this endpoint only provides classifications for NAICS Index Entries.
You can get classifications using [.h-code]GET[.h-code] [.h-endpoint-link]/classifications/naics_index_entries[.h-endpoint-link]. Each classification contains the Herald Code ([.h-code]id[.h-code]) you’ll use when submitting an application, along with information defined by NAICS. Here’s an example:
There are thousands of classifications to identify unique risks associated with an applicant. By default, getting classifications will return the first 100 classifications in numerical order by the [.h-code]naics_2017_6_digit[.h-code]. Delivering this entire list wouldn’t be useful or practical, so Herald recommends using queries when getting classifications for an applicant.
Search Query
Applying a Search query will return a list of relevant classifications based on their [.h-code]description[.h-code]. This query is powered by Elasticsearch, enabling fuzzy search to account for typos. Classifications are returned in priority order based on a number of factors considered by Elasticsearch.
For example, if you [.h-code]GET[.h-code] [.h-endpoint-link]/classifications/naics_index_entries[.h-endpoint-link] with the query [.h-code]?search=training[.h-code], you would get a list of classifications across all industries where training is relevant in the classification description.
NAICS Query
NAICS classifications can are categorized from a high level, at the 2-digit code for the sector, all the way to the granular 6-digit U.S. Industry code. The [.h-code]naics_2017[.h-code] query allows you to query to any combination of 2-digit to 6-digit 2017 NAICS codes, limiting the classification results to specific groups. For example:
- 61 is the code for the sector “Educational Services”. Applying the query [.h-code]naics_2017=61[.h-code] would limit your results to classifications that fall within the “Educational Services” sector.
- 6114 is the code for the industry group “Business Schools and Computer and Management Training”, which is in the “Educational Services” sector. Applying the query [.h-code]naics_2017=6114[.h-code] would limit your results to classifications that fall within the “Business Schools and Computer and Management Training” industry group.
- 611420 is the code for the U.S. industry “Computer Training”, which is in the “Business Schools and Computer and Management Training” industry group. Applying the query [.h-code]naics_2017=611420[.h-code] would limit your results to classifications that fall within the “Computer Training” U.S. industry.
Using the 6-digit code as an example, [.h-code]GET[.h-code] [.h-endpoint-link]/classifications/naics_index_entries[.h-endpoint-link] with the query [.h-code]?naics_2017=611420[.h-code] would return a list of all Index Entries that fall in the “Computer Training” U.S. industry.
You can query to multiple NAICS codes at the same time, and combine it with the [.h-code]search[.h-code] query. If you know that all of your applicants fall within Computer Training, you could apply the [.h-code]naics_2017[.h-code] query and allow them to search only within this list. Searching for “training” only within the Computer Training industry would return the following classifications:
Limit Query
The [.h-code]limit[.h-code] query limits the amount of classification results per page. Sticking with the example above, you could choose to limit the results to 3 classifications per page. Adding the query [.h-code]?limit=3[.h-code] to the query for [.h-code]?naics_2017=611420[.h-code] would only return the first 3 classifications:
Page Query
The [.h-code]page[.h-code] query can be used to paginate between pages of classifications. In the example above, we added a query to limit the results to 3 classifications. To get the second page of classifications, we would add the query [.h-code]?page=2[.h-code] and get the following:
Using Classifications
To classify an applicant with Herald, you need to submit the [.h-code]id[.h-code] of the classification when filling out an Application. This ID is the Herald Code for the classification, and should be submitted as the value for the risk parameter [.h-code]rsk_b3jm_2017_naics_index[.h-code]. The Herald Code will be mapped to each corresponding carriers’ code when the application is submitted.
This risk parameter supports multiple value, to support applicants that perform work across multiple industries. Learn more about submitting multiple values.
