v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Companies and Data Providers

Search companies with autocomplete

The endpoint provides company search using prefix.

get/v1/company-mappings-search/

Query parameters

querystring required

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

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

Example:income

Product type for success rate calculation

Response

company_mapping_idstring required

Company to Payroll Provider mapping ID

namestring required

Company name

domainstring nullable required

Company domain

logo_urlstring nullable

URL to company logo

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

Success rate for the company

confidence_levelstring 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 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",
    "sso": {
      "name": "Microsoft"
    }
  }
]