Onboarding Lookups
Reference lookup endpoints for dynamic validation lists used during customer onboarding (individual & business).
Some onboarding fields only accept values from a list, such as occupation, residence.state and company.industry. The lists change over time, so call the lookup instead of hard-coding the values. Send the value, not the label.
Find Your Lookups
Pick what you are onboarding to see which lookups to call. The values and examples are below.
Individual Lookups
Use these lookups for every individual, whether they onboard with Graded Onboarding (V2) or Standard Onboarding (V1).
There is one exception. A Standard Onboarding (V1) individual who lives outside the US gets the state from this V1 lookup instead:
GET /api/v1/countries/{country}/subdivisions
It returns codes such as ENG for the UK.
Occupations
GET /api/v2/customers/individual/occupations
Returns the occupation slugs. It isn't specific to a country.
{
"data": [
{ "value": "software_engineer", "label": "Software Engineer" },
{ "value": "teacher", "label": "Teacher" }
]
}See all occupations
value | label |
|---|---|
legislators_and_senior_officials | Legislators and Senior Officials |
managing_directors_and_chief_executives | Managing Directors and Chief Executives |
business_services_and_administration_managers | Business Services and Administration Managers |
sales_marketing_and_development_managers | Sales, Marketing and Development Managers |
production_managers_in_agriculture_forestry_and_fisheries | Production Managers in Agriculture, Forestry and Fisheries |
manufacturing_mining_construction_and_distribution_managers | Manufacturing, Mining, Construction and Distribution Managers |
information_and_communications_technology_service_managers | Information and Communications Technology Service managers |
professional_services_managers | Professional Services Managers |
hotel_and_restaurant_managers | Hotel and Restaurant Managers |
retail_and_wholesale_trade_managers | Retail and Wholesale Trade Managers |
other_services_managers | Other Services Managers |
physical_and_earth_science_professionals | Physical and Earth Science Professionals |
mathematicians_actuaries_and_statisticians | Mathematicians, Actuaries and Statisticians |
life_science_professionals | Life Science Professionals |
engineering_professionals_excluding_electrotechnology | Engineering Professionals (excluding Electrotechnology) |
electrotechnology_engineers | Electrotechnology Engineers |
architects_planners_surveyors_and_designers | Architects, Planners, Surveyors and Designers |
medical_doctors | Medical Doctors |
nursing_and_midwifery_professionals | Nursing and Midwifery Professionals |
traditional_and_complementary_medicine_professionals | Traditional and Complementary Medicine Professionals |
paramedical_practitioners | Paramedical Practitioners |
veterinarians | Veterinarians |
other_health_professionals | Other Health Professionals |
university_and_higher_education_teachers | University and Higher Education Teachers |
vocational_education_teachers | Vocational education teachers |
secondary_education_teachers | Secondary Education Teachers |
primary_school_and_early_childhood_teachers | Primary School and Early Childhood Teachers |
other_teaching_professionals | Other Teaching Professionals |
finance_professionals | Finance Professionals |
administration_professionals | Administration Professionals |
sales_marketing_and_public_relations_professionals | Sales, Marketing and Public Relations Professionals |
software_and_applications_developers_and_analysts | Software and Applications Developers and Analysts |
database_and_network_professionals | Database and Network Professionals |
legal_professionals | Legal Professionals |
librarians_archivists_and_curators | Librarians, Archivists and Curators |
social_and_religious_professionals | Social and Religious Professionals |
authors_journalists_and_linguists | Authors, Journalists and Linguists |
creative_and_performing_artists | Creative and Performing Artists |
physical_and_engineering_science_technicians | Physical and Engineering Science Technicians |
mining_manufacturing_and_construction_supervisors | Mining, Manufacturing and Construction Supervisors |
process_control_technicians | Process Control Technicians |
life_science_technicians_and_related_associate_professionals | Life Science Technicians and Related Associate Professionals |
ship_and_aircraft_controllers_and_technicians | Ship and Aircraft Controllers and Technicians |
medical_and_pharmaceutical_technicians | Medical and Pharmaceutical Technicians |
nursing_and_midwifery_associate_professionals | Nursing and Midwifery Associate Professionals |
traditional_and_complementary_medicine_associate_professionals | Traditional and Complementary Medicine Associate Professionals |
veterinary_technicians_and_assistants | Veterinary Technicians and Assistants |
other_health_associate_professionals | Other Health Associate Professionals |
financial_and_mathematical_associate_professionals | Financial and Mathematical Associate Professionals |
sales_and_purchasing_agents_and_brokers | Sales and Purchasing Agents and Brokers |
business_services_agents | Business Services Agents |
administrative_and_specialized_secretaries | Administrative and Specialized Secretaries |
government_regulatory_associate_professionals | Government Regulatory Associate Professionals |
legal_social_and_religious_associate_professionals | Legal, Social and Religious Associate Professionals |
sports_and_fitness_workers | Sports and Fitness Workers |
artistic_cultural_and_culinary_associate_professionals | Artistic, Cultural and Culinary Associate Professionals |
information_and_communications_technology_operations_and_user_support_technicians | Information and Communications Technology Operations and User Support Technicians |
telecommunications_and_broadcasting_technicians | Telecommunications and Broadcasting Technicians |
general_office_clerks | General Office Clerks |
secretaries_general | Secretaries (general) |
keyboard_operators | Keyboard Operators |
tellers_money_collectors_and_related_clerks | Tellers, Money Collectors and Related Clerks |
client_information_workers | Client Information Workers |
numerical_clerks | Numerical Clerks |
material_recording_and_transport_clerks | Material Recording and Transport Clerks |
other_clerical_support_workers | Other Clerical Support Workers |
travel_attendants_conductors_and_guides | Travel Attendants, Conductors and Guides |
cooks | Cooks |
waiters_and_bartenders | Waiters and Bartenders |
hairdressers_beauticians_and_related_workers | Hairdressers, Beauticians and Related Workers |
building_and_housekeeping_supervisors | Building and Housekeeping Supervisors |
other_personal_services_workers | Other Personal Services Workers |
street_and_market_salespersons | Street and Market Salespersons |
shop_aalespersons | Shop Aalespersons |
cashiers_and_ticket_clerks | Cashiers and Ticket Clerks |
other_sales_workers | Other Sales Workers |
child_care_workers_and_teachers_aides | Child Care Workers and Teachers’ Aides |
personal_care_workers_in_health_services | Personal Care Workers in Health Services |
protective_services_workers | Protective Services Workers |
market_gardeners_and_crop_growers | Market Gardeners and Crop Growers |
animal_producers | Animal Producers |
mixed_crop_and_animal_producers | Mixed Crop and Animal Producers |
forestry_and_related_workers | Forestry and Related Workers |
fishery_workers_hunters_and_trappers | Fishery Workers, Hunters and Trappers |
subsistence_crop_farmers | Subsistence Crop Farmers |
subsistence_livestock_farmers | Subsistence Livestock Farmers |
subsistence_mixed_crop_and_livestock_farmers | Subsistence Mixed Crop and Livestock Farmers |
subsistence_fishers_hunters_trappers_and_gatherers | Subsistence Fishers, Hunters, Trappers and Gatherers |
building_frame_and_related_trades_workers | Building Frame and Related Trades Workers |
building_finishers_and_related_trades_workers | Building Finishers and Related Trades Workers |
painters_building_structure_cleaners_and_related_trades_workers | Painters, Building Structure Cleaners and Related Trades Workers |
sheet_and_structural_metal_workers_moulders_and_welders_and_related_trades_workers | Sheet and Structural Metal Workers, Moulders and Welders, and Related Trades Workers |
blacksmiths_toolmakers_and_related_trades_workers_trades_workers | Blacksmiths, Toolmakers and Related Trades Workers (trades workers) |
machinery_mechanics_and_fitters | Machinery Mechanics and Fitters |
electrical_equipment_installers_and_repairers_trades_workers | Electrical Equipment Installers and Repairers (trades workers) |
electronics_and_telecommunications_installers_and_repairers_trades_workers | Electronics and Telecommunications Installers and Repairers (trades workers) |
food_processing_woodworking_garment_and_other_craft_and_related_trades_workers | Food Processing, Woodworking, Garment and Other Craft and Related Trades Workers |
mining_and_mineral_processing_plant_operators_plant_operators | Mining and Mineral Processing Plant Operators (plant operators) |
metal_processing_and_finishing_plant_operators_plant_operators | Metal Processing and Finishing Plant Operators (plant operators) |
chemical_and_photographic_products_plant_and_machine_operators_plant_operators | Chemical and Photographic Products Plant and Machine Operators (plant operators) |
rubber_plastic_and_paper_products_machine_operators_plant_operators | Rubber, Plastic and Paper Products Machine Operators (plant operators) |
textile_fur_and_leather_products_machine_operators_plant_operators | Textile, Fur and Leather Products Machine Operators (plant operators) |
food_and_related_products_machine_operators_plant_operators | Food and Related Products Machine Operators (plant operators) |
wood_processing_and_papermaking_plant_operators_plant_operators | Wood Processing and Papermaking Plant Operators (plant operators) |
other_stationary_plant_and_machine_operators_plant_operators | Other Stationary Plant and Machine Operators (plant operators) |
assemblers_plant_operators | Assemblers (plant operators) |
locomotive_engine_drivers_and_related_workers_drivers | Locomotive Engine Drivers and Related Workers (drivers) |
car_van_and_motorcycle_drivers_drivers | Car, Van and Motorcycle Drivers (drivers) |
heavy_truck_and_bus_drivers_drivers | Heavy Truck and Bus Drivers (drivers) |
mobile_plant_operators_drivers | Mobile Plant Operators (drivers) |
ships_deck_crews_and_related_workers_drivers | Ships’ Deck Crews and Related Workers (drivers) |
domestic_hotel_and_office_cleaners_and_helpers_labourers | Domestic, Hotel and Office Cleaners and Helpers (labourers) |
vehicle_window_laundry_and_other_hand_cleaning_workers_labourers | Vehicle, Window, Laundry and Other Hand Cleaning Workers (labourers) |
agricultural_forestry_and_fishery_labourers_labourers | Agricultural, Forestry and Fishery Labourers (labourers) |
mining_and_construction_labourers_labourers | Mining and Construction Labourers (labourers) |
manufacturing_labourers_labourers | Manufacturing Labourers (labourers) |
transport_and_storage_labourers_labourers | Transport and Storage Labourers (labourers) |
food_preparation_assistants_labourers | Food Preparation Assistants (labourers) |
street_and_related_service_workers_labourers | Street and Related Service Workers (labourers) |
street_and_market_salespersons_excluding_food | Street and Market Salespersons (excluding food) |
garbage_collectors_and_other_elementary_workers | Garbage Collectors and Other Elementary Workers |
commissioned_armed_forces_officers_armed_forces | Commissioned Armed Forces Officers (armed forces) |
non_commissioned_armed_forces_officers_armed_forces | Non-commissioned Armed Forces Officers (armed forces) |
armed_forces_occupations_other_ranks_armed_forces | Armed Forces Occupations, Other Ranks (armed forces) |
unemployed | Unemployed |
US states
GET /api/v2/customers/individual/countries/{country}/subdivisions
Returns the states of the United States, such as Florida or Washington, that Harbor serves. It doesn't return the states or regions of other countries, such as Mexico or the UK. For those countries the list is empty, so leave out residence.state.
{
"data": [
{ "code": "FL", "name": "Florida", "type": "State" },
{ "code": "WA", "name": "Washington", "type": "State" }
]
}{
"data": []
}See all US states and territories
The V2 endpoint returns only the 41 US states that Harbor serves for individuals. This is the full V1 list.
code | name |
|---|---|
AK | Alaska |
AL | Alabama |
AR | Arkansas |
AZ | Arizona |
CA | California |
CO | Colorado |
DC | District of Columbia |
DE | Delaware |
FL | Florida |
GA | Georgia |
GU | Guam |
HI | Hawaii |
IA | Iowa |
ID | Idaho |
IL | Illinois |
IN | Indiana |
KS | Kansas |
KY | Kentucky |
LA | Louisiana |
MA | Massachusetts |
MD | Maryland |
ME | Maine |
MI | Michigan |
MN | Minnesota |
MO | Missouri |
MP | Northern Mariana Islands |
MS | Mississippi |
MT | Montana |
NC | North Carolina |
ND | North Dakota |
NE | Nebraska |
NH | New Hampshire |
NM | New Mexico |
NV | Nevada |
OH | Ohio |
OK | Oklahoma |
OR | Oregon |
PA | Pennsylvania |
PR | Puerto Rico |
RI | Rhode Island |
SC | South Carolina |
SD | South Dakota |
TN | Tennessee |
TX | Texas |
UM | United States Minor Outlying Islands |
UT | Utah |
VA | Virginia |
VI | Virgin Islands, U.S. |
VT | Vermont |
WA | Washington |
WI | Wisconsin |
WV | West Virginia |
WY | Wyoming |
Identity documents
GET /api/v2/customers/individual/countries/{country}/identity_documents
Returns the document types for a country, the parts required for each, and whether the back side is required. Each country has its own rules. For example, a driver's licence needs a front and a back in the US, but only a front in the UK and Brazil.
{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT"], "back_required": false },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT"], "back_required": false }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT"], "back_required": false },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}These are only a few examples. Other countries work the same way. Call the endpoint with the country's code.
The document types are PASSPORT, NATIONAL_ID and DRIVER_LICENCE, where the country supports them. RESIDENCE_PERMIT isn't accepted for individuals. This is also the list to use for Standard Onboarding (V1) individuals.
Business Lookups
Businesses use the Standard Onboarding (V1) lookups. Each one is for a field in the business request.
Industries
GET /api/v1/countries/{country}/industries
Use the country of incorporation. Each country has its own list of industries, so the values and the number of options are different from one country to another.
{
"data": [
{ "value": "soybean_farming", "label": "Soybean Farming" },
{ "value": "wheat_farming", "label": "Wheat Farming" }
]
}{
"data": [
{ "value": "education", "label": "Education" },
{ "value": "telecommunications", "label": "Telecommunications" }
]
}{
"data": [
{ "value": "hotels", "label": "Hotels" },
{ "value": "pubs", "label": "Pubs" }
]
}{
"data": [
{ "value": "fishing", "label": "Fishing" },
{ "value": "securities", "label": "Securities" }
]
}These are only a few examples. Other countries work the same way. Call the endpoint with the country's code. The UK, Mexico and Brazil share the same list of 48 industries.
Job titles
GET /api/v1/job-titles
value | label |
|---|---|
founder | Founder |
chiefExecutiveOfficer | Chief executive officer |
chiefComplianceOfficer | Chief compliance officer |
chiefFinancialOfficer | Chief financial officer |
chiefOperatingOfficer | Chief operating officer |
president | President |
vicePresident | Vice president |
director | Director |
other | Other |
States
GET /api/v1/countries/{country}/subdivisions
Returns the states, provinces or regions of a country. Each country has its own list.
{
"data": [
{ "code": "FL", "name": "Florida", "type": "State" },
{ "code": "WA", "name": "Washington", "type": "State" }
]
}{
"data": [
{ "code": "ENG", "name": "England", "type": "Country" },
{ "code": "SCT", "name": "Scotland", "type": "Country" }
]
}{
"data": [
{ "code": "JAL", "name": "Jalisco", "type": "State" },
{ "code": "NLE", "name": "Nuevo León", "type": "State" }
]
}{
"data": [
{ "code": "SP", "name": "São Paulo", "type": "State" },
{ "code": "RJ", "name": "Rio de Janeiro", "type": "State" }
]
}{
"data": [
{ "code": "01", "name": "Central Singapore", "type": "District" },
{ "code": "02", "name": "North East", "type": "District" }
]
}{
"data": [
{ "code": "CHA", "name": "Changhua", "type": "County" },
{ "code": "CYI", "name": "Chiayi", "type": "City" }
]
}These are only a few examples. Other countries work the same way. Call the endpoint with the country's code.
Identity documents
GET /api/v1/countries/{country}/identity_documents
Returns the document types accepted for a country, and which images each type needs. Use it for each person's identity_files. A part that isn't in required_parts for the type is rejected.
This list can include RESIDENCE_PERMIT, which a business's associated persons can use. Individuals can't.
Each country has its own rules. For example, a driver's licence needs a front and a back in the US, but only a front in the UK and Brazil.
{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT"], "back_required": false },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT"], "back_required": false }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT"], "back_required": false },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}{
"data": [
{ "type": "DRIVER_LICENCE", "required_parts": ["FRONT", "BACK"], "back_required": true },
{ "type": "NATIONAL_ID", "required_parts": ["FRONT", "BACK"], "back_required": true }
]
}These are only a few examples. Other countries work the same way. Call the endpoint with the country's code.
Notes
A few things to know when you use the lookups.
{country}is an ISO 3166-1 alpha-2 code, such asUS.- Harbor serves 41 US states for individuals.
- Onboarding Fixed Lists also lists the fixed values for
company.typeandcompany.source_of_funds.
Updated 29 days ago