Skip to main content
  • The endpoint returns a list of Items that best match the user’s query.
  • Visually display the Item results in your search dropdown. Search results can be continuously updated real-time as the user enters their employer name letter-by-letter.
  • When the user selects the Item that represents their employer, the Item’s id returned by the endpoint can be used to directly connect users to that specific Item in Link using the direct login method.
Visit our Employer Search Guide for an in-depth overview, example search demo, and Github sample project.

​
The employer search object

​
id
string

Unique ID of the Item. ID format - item_123456789

​
name
string

Name of the Item.

​
logo_url
string

URL location of the Item's logo image file.

​
kind
enum<string>

Type of Item.

  • employer - individual employer
  • gig - gig platform
  • platform - payroll provider platform
  • benefits - government benefits
Available options:
employer,
gig,
platform,
benefits
​
mapping_status
enum<string>

Verification status of the Item.

  • verified - The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data.

  • mapped - The payroll system associated with the Item is known, but the Item is awaiting a successful connection.

  • unmapped - The payroll system associated with this Item is not yet known. If an unmapped Item is selected in Link, the user will be given the option to search for the relevant payroll system and attempt to connect using their login credentials.

Available options:
verified,
mapped,
unmapped
​
status
enum<string>

Health status of the Item.

  • healthy - Normal service.
  • issues - Impacted service. New account connections still supported.
  • unavailable - Impacted service. New account connections not supported. Ongoing refresh paused.
Available options:
healthy,
issues,
unavailable