Skip to main content
A Company represents an organization where a user works and receives income. Truv Bridge prompts users with a company search by default, allowing users to find and connect their employer’s payroll system. When a company_mapping_id is passed directly into Truv Bridge, the user skips the search step entirely and goes straight to authentication.
Check a company’s success_rate and mapping_status before creating an order to optimize the user experience and decide whether to fall back to document upload.

Attributes

AttributeTypeDescription
company_mapping_idStringUnique company identifier. Pass to Truv Bridge to bypass employer search.
nameStringCompany name
domainStringUnique web domain of the company
logo_urlStringURL to the company’s logo
confidence_levelFloatPredicted success rate (0.0–1.0; values ≥ 0.5 indicate high success)
success_rateStringClassification: "high", "low", "unsupported", or null
mapping_statusStringIntegration status: "verified", "mapped", or "unmapped"

Endpoints

Company Autocomplete Search

Search companies by name with autocomplete. Use results to populate or pre-fill Truv Bridge.

Company Info

Retrieve detailed attributes for a specific company by its mapping ID

Company Mapping

Map a domain or company name to a Truv company record and mapping ID

Example response

{
  "company_mapping_id": "48427a36d43c4d5aa6324bc06c692456",
  "name": "Facebook Demo",
  "domain": "facebook.com",
  "logo_url": "https://citadelid-resources.s3-us-west-2.amazonaws.com/facebook.png",
  "confidence_level": "0.9",
  "success_rate": "high",
  "mapping_status": "verified"
}

Common use cases

Use success_rate and mapping_status to decide whether to offer payroll-based verification or prompt the user to upload documents instead.
success_ratemapping_statusRecommendation
"high""verified"Proceed with payroll verification
"low""mapped"Offer document upload as primary path
"unsupported""unmapped"Skip payroll. Go straight to document upload.