Overview

A Company represents an organization where a user works and receives income. Truv Bridge prompts users with company search as a default after opening. Find the full list of Companies on the Truv Coverage page.

Company search also works separately when using a company ID value passed into Truv Bridge. This streamlines the user experience and lets users skip the search process.

Data Providers represent a user data storage system. Each company has one Data Provider in mapping use cases.

Attributes

View the values below for the companies and data providers endpoint.

Company attributes

The values in this table are from Company attributes.

Attribute	Type	Description
company_mapping_id	string	Company unique ID
name	string	Company name
domain	string	Web domain of company, unique value
logo_url	string	Company logo URL
confidence_level	float	Confidence level for the company success rate. Range of possible values is from 0 to 1 0.5 and above being high success rate
success_rate	string \| null	Success rate for the company: `high` - Expected to succeed `low` - May succeed, send if the user knows their payroll provider and is confident `unsupported` - Verification via payroll is not feasible `null` - Not enough attempts to determine success
mapping_status	string	Mapping status of the company to the payroll system: `verified` - Truv has manually verified that the mapped payroll provider for this employer is correct `mapped` - Truv has a payroll provider mapped for this employer and the end-user will not need to select one from the Truv bridge `unmapped` - Truv does not have a payroll provider mapped for this employer and the user will have to select one manually.

Data provider attributes

This table contains attributes from the Data Provider.

Attribute	Type	Description
id	string	Data provider unique ID
name	string	Data provider name
is_supported	Boolean	Status of data provider support for product

Endpoints

The list below has the available endpoints.

Example response

The example object below is from the Search Companies endpoint.

{
  "company_mapping_id": "48427a36d43c4d5aa6324bc06c692456",
  "name": "Facebook Demo",
  "domain": "facebook.com",
  "logo_url": "https://citadelid-resources.s3-us-west-2.amazonaws.com/facebook.png",
  "confidence_level": "0.9"
}