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.

Who are you onboarding?

Which onboarding?

Call these lookups

Graded Onboarding (V2) for an individual

Occupations
GET /api/v2/customers/individual/occupations

The values for occupation.

States
GET /api/v2/customers/individual/countries/{country}/subdivisions

The US states Harbor serves. Other countries return an empty list.

Identity documents
GET /api/v2/customers/individual/countries/{country}/identity_documents

The document types for a country, and which sides each one needs.

Only the US has states. For other countries, leave out residence.state.

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
valuelabel
legislators_and_senior_officialsLegislators and Senior Officials
managing_directors_and_chief_executivesManaging Directors and Chief Executives
business_services_and_administration_managersBusiness Services and Administration Managers
sales_marketing_and_development_managersSales, Marketing and Development Managers
production_managers_in_agriculture_forestry_and_fisheriesProduction Managers in Agriculture, Forestry and Fisheries
manufacturing_mining_construction_and_distribution_managersManufacturing, Mining, Construction and Distribution Managers
information_and_communications_technology_service_managersInformation and Communications Technology Service managers
professional_services_managersProfessional Services Managers
hotel_and_restaurant_managersHotel and Restaurant Managers
retail_and_wholesale_trade_managersRetail and Wholesale Trade Managers
other_services_managersOther Services Managers
physical_and_earth_science_professionalsPhysical and Earth Science Professionals
mathematicians_actuaries_and_statisticiansMathematicians, Actuaries and Statisticians
life_science_professionalsLife Science Professionals
engineering_professionals_excluding_electrotechnologyEngineering Professionals (excluding Electrotechnology)
electrotechnology_engineersElectrotechnology Engineers
architects_planners_surveyors_and_designersArchitects, Planners, Surveyors and Designers
medical_doctorsMedical Doctors
nursing_and_midwifery_professionalsNursing and Midwifery Professionals
traditional_and_complementary_medicine_professionalsTraditional and Complementary Medicine Professionals
paramedical_practitionersParamedical Practitioners
veterinariansVeterinarians
other_health_professionalsOther Health Professionals
university_and_higher_education_teachersUniversity and Higher Education Teachers
vocational_education_teachersVocational education teachers
secondary_education_teachersSecondary Education Teachers
primary_school_and_early_childhood_teachersPrimary School and Early Childhood Teachers
other_teaching_professionalsOther Teaching Professionals
finance_professionalsFinance Professionals
administration_professionalsAdministration Professionals
sales_marketing_and_public_relations_professionalsSales, Marketing and Public Relations Professionals
software_and_applications_developers_and_analystsSoftware and Applications Developers and Analysts
database_and_network_professionalsDatabase and Network Professionals
legal_professionalsLegal Professionals
librarians_archivists_and_curatorsLibrarians, Archivists and Curators
social_and_religious_professionalsSocial and Religious Professionals
authors_journalists_and_linguistsAuthors, Journalists and Linguists
creative_and_performing_artistsCreative and Performing Artists
physical_and_engineering_science_techniciansPhysical and Engineering Science Technicians
mining_manufacturing_and_construction_supervisorsMining, Manufacturing and Construction Supervisors
process_control_techniciansProcess Control Technicians
life_science_technicians_and_related_associate_professionalsLife Science Technicians and Related Associate Professionals
ship_and_aircraft_controllers_and_techniciansShip and Aircraft Controllers and Technicians
medical_and_pharmaceutical_techniciansMedical and Pharmaceutical Technicians
nursing_and_midwifery_associate_professionalsNursing and Midwifery Associate Professionals
traditional_and_complementary_medicine_associate_professionalsTraditional and Complementary Medicine Associate Professionals
veterinary_technicians_and_assistantsVeterinary Technicians and Assistants
other_health_associate_professionalsOther Health Associate Professionals
financial_and_mathematical_associate_professionalsFinancial and Mathematical Associate Professionals
sales_and_purchasing_agents_and_brokersSales and Purchasing Agents and Brokers
business_services_agentsBusiness Services Agents
administrative_and_specialized_secretariesAdministrative and Specialized Secretaries
government_regulatory_associate_professionalsGovernment Regulatory Associate Professionals
legal_social_and_religious_associate_professionalsLegal, Social and Religious Associate Professionals
sports_and_fitness_workersSports and Fitness Workers
artistic_cultural_and_culinary_associate_professionalsArtistic, Cultural and Culinary Associate Professionals
information_and_communications_technology_operations_and_user_support_techniciansInformation and Communications Technology Operations and User Support Technicians
telecommunications_and_broadcasting_techniciansTelecommunications and Broadcasting Technicians
general_office_clerksGeneral Office Clerks
secretaries_generalSecretaries (general)
keyboard_operatorsKeyboard Operators
tellers_money_collectors_and_related_clerksTellers, Money Collectors and Related Clerks
client_information_workersClient Information Workers
numerical_clerksNumerical Clerks
material_recording_and_transport_clerksMaterial Recording and Transport Clerks
other_clerical_support_workersOther Clerical Support Workers
travel_attendants_conductors_and_guidesTravel Attendants, Conductors and Guides
cooksCooks
waiters_and_bartendersWaiters and Bartenders
hairdressers_beauticians_and_related_workersHairdressers, Beauticians and Related Workers
building_and_housekeeping_supervisorsBuilding and Housekeeping Supervisors
other_personal_services_workersOther Personal Services Workers
street_and_market_salespersonsStreet and Market Salespersons
shop_aalespersonsShop Aalespersons
cashiers_and_ticket_clerksCashiers and Ticket Clerks
other_sales_workersOther Sales Workers
child_care_workers_and_teachers_aidesChild Care Workers and Teachers’ Aides
personal_care_workers_in_health_servicesPersonal Care Workers in Health Services
protective_services_workersProtective Services Workers
market_gardeners_and_crop_growersMarket Gardeners and Crop Growers
animal_producersAnimal Producers
mixed_crop_and_animal_producersMixed Crop and Animal Producers
forestry_and_related_workersForestry and Related Workers
fishery_workers_hunters_and_trappersFishery Workers, Hunters and Trappers
subsistence_crop_farmersSubsistence Crop Farmers
subsistence_livestock_farmersSubsistence Livestock Farmers
subsistence_mixed_crop_and_livestock_farmersSubsistence Mixed Crop and Livestock Farmers
subsistence_fishers_hunters_trappers_and_gatherersSubsistence Fishers, Hunters, Trappers and Gatherers
building_frame_and_related_trades_workersBuilding Frame and Related Trades Workers
building_finishers_and_related_trades_workersBuilding Finishers and Related Trades Workers
painters_building_structure_cleaners_and_related_trades_workersPainters, Building Structure Cleaners and Related Trades Workers
sheet_and_structural_metal_workers_moulders_and_welders_and_related_trades_workersSheet and Structural Metal Workers, Moulders and Welders, and Related Trades Workers
blacksmiths_toolmakers_and_related_trades_workers_trades_workersBlacksmiths, Toolmakers and Related Trades Workers (trades workers)
machinery_mechanics_and_fittersMachinery Mechanics and Fitters
electrical_equipment_installers_and_repairers_trades_workersElectrical Equipment Installers and Repairers (trades workers)
electronics_and_telecommunications_installers_and_repairers_trades_workersElectronics and Telecommunications Installers and Repairers (trades workers)
food_processing_woodworking_garment_and_other_craft_and_related_trades_workersFood Processing, Woodworking, Garment and Other Craft and Related Trades Workers
mining_and_mineral_processing_plant_operators_plant_operatorsMining and Mineral Processing Plant Operators (plant operators)
metal_processing_and_finishing_plant_operators_plant_operatorsMetal Processing and Finishing Plant Operators (plant operators)
chemical_and_photographic_products_plant_and_machine_operators_plant_operatorsChemical and Photographic Products Plant and Machine Operators (plant operators)
rubber_plastic_and_paper_products_machine_operators_plant_operatorsRubber, Plastic and Paper Products Machine Operators (plant operators)
textile_fur_and_leather_products_machine_operators_plant_operatorsTextile, Fur and Leather Products Machine Operators (plant operators)
food_and_related_products_machine_operators_plant_operatorsFood and Related Products Machine Operators (plant operators)
wood_processing_and_papermaking_plant_operators_plant_operatorsWood Processing and Papermaking Plant Operators (plant operators)
other_stationary_plant_and_machine_operators_plant_operatorsOther Stationary Plant and Machine Operators (plant operators)
assemblers_plant_operatorsAssemblers (plant operators)
locomotive_engine_drivers_and_related_workers_driversLocomotive Engine Drivers and Related Workers (drivers)
car_van_and_motorcycle_drivers_driversCar, Van and Motorcycle Drivers (drivers)
heavy_truck_and_bus_drivers_driversHeavy Truck and Bus Drivers (drivers)
mobile_plant_operators_driversMobile Plant Operators (drivers)
ships_deck_crews_and_related_workers_driversShips’ Deck Crews and Related Workers (drivers)
domestic_hotel_and_office_cleaners_and_helpers_labourersDomestic, Hotel and Office Cleaners and Helpers (labourers)
vehicle_window_laundry_and_other_hand_cleaning_workers_labourersVehicle, Window, Laundry and Other Hand Cleaning Workers (labourers)
agricultural_forestry_and_fishery_labourers_labourersAgricultural, Forestry and Fishery Labourers (labourers)
mining_and_construction_labourers_labourersMining and Construction Labourers (labourers)
manufacturing_labourers_labourersManufacturing Labourers (labourers)
transport_and_storage_labourers_labourersTransport and Storage Labourers (labourers)
food_preparation_assistants_labourersFood Preparation Assistants (labourers)
street_and_related_service_workers_labourersStreet and Related Service Workers (labourers)
street_and_market_salespersons_excluding_foodStreet and Market Salespersons (excluding food)
garbage_collectors_and_other_elementary_workersGarbage Collectors and Other Elementary Workers
commissioned_armed_forces_officers_armed_forcesCommissioned Armed Forces Officers (armed forces)
non_commissioned_armed_forces_officers_armed_forcesNon-commissioned Armed Forces Officers (armed forces)
armed_forces_occupations_other_ranks_armed_forcesArmed Forces Occupations, Other Ranks (armed forces)
unemployedUnemployed


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" }
    ]
}
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.

codename
AKAlaska
ALAlabama
ARArkansas
AZArizona
CACalifornia
COColorado
DCDistrict of Columbia
DEDelaware
FLFlorida
GAGeorgia
GUGuam
HIHawaii
IAIowa
IDIdaho
ILIllinois
INIndiana
KSKansas
KYKentucky
LALouisiana
MAMassachusetts
MDMaryland
MEMaine
MIMichigan
MNMinnesota
MOMissouri
MPNorthern Mariana Islands
MSMississippi
MTMontana
NCNorth Carolina
NDNorth Dakota
NENebraska
NHNew Hampshire
NMNew Mexico
NVNevada
OHOhio
OKOklahoma
OROregon
PAPennsylvania
PRPuerto Rico
RIRhode Island
SCSouth Carolina
SDSouth Dakota
TNTennessee
TXTexas
UMUnited States Minor Outlying Islands
UTUtah
VAVirginia
VIVirgin Islands, U.S.
VTVermont
WAWashington
WIWisconsin
WVWest Virginia
WYWyoming


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 }
    ]
}

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" }
    ]
}

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

valuelabel
founderFounder
chiefExecutiveOfficerChief executive officer
chiefComplianceOfficerChief compliance officer
chiefFinancialOfficerChief financial officer
chiefOperatingOfficerChief operating officer
presidentPresident
vicePresidentVice president
directorDirector
otherOther

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" }
    ]
}

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 }
    ]
}

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 as US.
  • Harbor serves 41 US states for individuals.
  • Onboarding Fixed Lists also lists the fixed values for company.type and company.source_of_funds.

Did this page help you?