v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB

Companies and Data Providers

Search companies

The endpoint returns the company_mapping_id for a company if it exists. This company_mapping_id can be passed to the /bridge-tokens endpoint to have the user skip the company selection step and suggest a data provider.

post/v1/companies/

Request body

namestring

Company name

domainstring nullable

Company domain

einstring

Company EIN

phonestring

Company phone number

idstring

Company ID

product_type'income' | 'employment' | 'deposit_switch' | 'pll'

Product type for success rate calculation

Example request

{
  "name": "Google",
  "domain": "google.com",
  "ein": "770493581",
  "address": {
    "street": "1600 Amphitheatre Pkwy",
    "city": "Mountain View",
    "state": "CA",
    "zip": "94043"
  },
  "phone": "6503087300",
  "id": "d94df7ecffcb4b218ab2dbff70e7cda8",
  "product_type": "income"
}

Response

company_mapping_idstring nullable

Company to Payroll Provider mapping ID

namestring

Company name

domainstring

Company domain

logo_urlstring nullable

URL to company logo

success_rate'low' | 'high' | 'unsupported' | 'null' nullable

Success rate for the company

confidence_levelstring

Confidence level for the company success rate. Range of possible values is from 0 to 1 with 0.5 and above being high success rate

mapping_status'verified' | 'mapped' | 'unmapped'

Mapping status of the company to the payroll system

Example response

{
  "company_mapping_id": "48427a36d43c4d5aa6324bc06c692456",
  "name": "Facebook Demo",
  "domain": "facebook.com",
  "logo_url": "https://cdn.truv.com/facebook.png",
  "success_rate": "high",
  "confidence_level": "0.9",
  "mapping_status": "verified"
}

All 89 operations