Skip to main content
GET
/
v1
/
company-mappings-search
Search Companies with Autocomplete
curl --request GET \
  --url https://api.example.com/v1/company-mappings-search/

​
Overview

The endpoint provides company search using prefix-based matching. This functionality enables users to locate companies through autocomplete-style queries that support partial matching and fuzzy matching for handling typos.

​
Request

​
Endpoint

GET https://prod.transcrypts.com/v1/company-mappings-search/

​
Authentication

API authentication requires the following headers:
HeaderDescription
X-Access-Client-IdYour Client ID
X-Access-SecretYour Access Key

​
Query Parameters

ParameterTypeRequiredDescription
querystringYesSearch query to find companies. Searches across company names, domains, and synonyms. Supports partial matching and fuzzy matching for typos.
product_typestringNoProduct type for success rate calculation. Allowed values: income, employment, deposit_switch, pll

​
Response

​
Success Response (HTTP 200)

The endpoint returns an array of company objects. 
[
  {
    "company_mapping_id": "48427a36d43c4d5aa6324bc06c692456",
    "name": "Facebook Demo",
    "domain": "facebook.com",
    "logo_url": "https://citadelid-resources.s3-us-west-2.amazonaws.com/facebook.png",
    "success_rate": "high",
    "confidence_level": "0.9",
    "sso": {
      "name": "Microsoft"
    }
  }
]

​
Response Fields

FieldTypeDescription
company_mapping_idstringCompany to Payroll Provider mapping ID
namestringCompany name
domainstring (nullable)Company domain
logo_urlstring (nullable)URL to company logo
success_ratestringValues: low, high, unsupported, or null
confidence_levelstringRange 0 to 1; values >= 0.5 indicate high success rate
ssoobject (nullable)SSO provider information with name field

​
Error Responses

Status CodeDescription
401Unauthorized - Authentication failed
403Forbidden - Insufficient permissions