Skip to main content
POST
/
v1
/
companies
Search companies
curl --request POST \
  --url https://prod.truv.com/v1/companies/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "name": "Google",
  "domain": "google.com",
  "ein": "770493581",
  "phone": "6503087300",
  "id": "d94df7ecffcb4b218ab2dbff70e7cda8",
  "product_type": "income"
}
'
{
  "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"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Body

application/json
​
name
string

Company name

Example:

"Google"

​
domain
string

Company domain

Example:

"google.com"

​
ein
string

Company EIN

Example:

"770493581"

​
address
object

Company location address object

​
phone
string

Company phone number

Example:

"6503087300"

​
id
string

Company ID

Example:

"d94df7ecffcb4b218ab2dbff70e7cda8"

​
product_type
enum<string>

Product type for success rate calculation

Available options:
income,
employment,
deposit_switch,
pll

Response

​
company_mapping_id
string | null

Company to Payroll Provider mapping ID

Example:

"48427a36d43c4d5aa6324bc06c692456"

​
name
string

Company name

Example:

"Facebook Demo"

​
domain
string

Company domain

Example:

"facebook.com"

​
logo_url
string | null

URL to company logo

Example:

"https://cdn.truv.com/facebook.png"

​
success_rate
enum<string> | null

Success rate for the company

Available options:
low,
high,
unsupported,
null
Example:

"high"

​
confidence_level
string

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

Example:

"0.9"

​
mapping_status
enum<string>

Mapping status of the company to the payroll system

Available options:
verified,
mapped,
unmapped
Example:

"verified"