Skip to main content
GET
/
v1
/
company-mappings-search
Search companies with autocomplete
curl --request GET \
  --url https://prod.truv.com/v1/company-mappings-search/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
[
  {
    "company_mapping_id": "48427a36d43c4d5aa6324bc06c692456",
    "name": "Facebook Demo",
    "domain": "facebook.com",
    "success_rate": "high",
    "confidence_level": "0.9",
    "logo_url": "https://cdn.truv.com/facebook.png",
    "sso": {
      "name": "Microsoft"
    }
  }
]

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Query Parameters

​
query
string
required

Search query to find companies. Searches across company names, domains, and synonyms. Supports partial matching and fuzzy matching for typos.

​
product_type
enum<string>

Product type for success rate calculation

Available options:
income,
employment,
deposit_switch,
pll

Response

​
company_mapping_id
string
required

Company to Payroll Provider mapping ID

Example:

"48427a36d43c4d5aa6324bc06c692456"

​
name
string
required

Company name

Example:

"Facebook Demo"

​
domain
string | null
required

Company domain

Example:

"facebook.com"

​
success_rate
enum<string> | null
required

Success rate for the company

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

"high"

​
confidence_level
string
required

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"

​
logo_url
string | null

URL to company logo

Example:

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

​
sso
object

SSO provider for the company