Skip to main content
introSearchPlaceholder (string) optional
  • Change the placeholder text in the search box in the Intro Screen of Link.
  • Defaults to “Find and link your employer.”
searchScreenTitle (string) optional
  • Changes the main title of the Search Screen.
  • Defaults to “Search for your income source.”
searchScreenSubtitle (string) optional
  • Changes the subtitle of the Search Screen.
  • Defaults to “Find your employer, gig platform, or payroll provider.”

​
API

​
Employments

employment_status (string)
  • Status of employment. Possible values: active or terminated.
  • Deprecated in favor of employments.status.
employment_type (string)
  • Type of employment (e.g. part-time, full-time, hourly, salary, contractor).
  • Deprecated in favor of employments.type.
job_title (string)
  • The current job title of the user. The value will usually be a free-form text returned from the data partner—for example, sales associate, driver.
  • Deprecated in favor of employments.job_title.
platform_user_id (string)
  • ID from the data partner platform.
  • Deprecated in favor of employments.platform_user_id.
hire_dates (array of strings)
  • An array of dates when the user was hired with respect to this particular profile. Timestamps follow the ISO 8601 standard.
  • Deprecated in favor of employments.hire_datetime.
terminations (array of objects)
  • List of all termination events of a user with respect to this particular profile.
  • Deprecated in favor of employments.termination_datetime and employments.termination_reason.
terminations[].date (string)
  • Date of the termination event. Timestamps follow the ISO 8601 standard.
  • Deprecated in favor of employments.termination_datetime.
terminations[].reason (string)
  • Reason for the termination event. Free-form text entry provided by the data partner.
  • Deprecated in favor of employments.termination_reason.

​
Activities

income.taxes (string)
  • Taxes incurred by the worker during this activity.