v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB

Companies and Data Providers

Get company information

The endpoint returns detailed information for a specific company mapping, including basic company details, success rate, and bank account information.

get/v1/companies/{company_mapping_id}/

Query parameters

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

Example:income

Product type for success rate calculation

Response

company_mapping_idstring nullable

Company mapping ID

namestring

Company name

domainstring nullable

Company domain

logo_urlstring nullable

URL to company logo

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

Success rate for the company

confidence_levelstring

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

mapping_status'verified' | 'mapped' | 'unmapped'

Mapping status of the company to the payroll system

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",
  "mapping_status": "verified",
  "features": {
    "deposit_switch": {
      "max_number": 3,
      "deposit_types": [
        "entire",
        "percent",
        "amount"
      ],
      "amount_precision": "0.01",
      "percent_precision": "0.01"
    },
    "fill_rates": {
      "job_title": 0.85,
      "job_type": 0.92,
      "is_active": 0.8,
      "start_date": 0.78,
      "original_hire_date": 0.77,
      "income": 0.95,
      "income_unit": 0.88,
      "pay_frequency": 0.91,
      "w2s": 0.73,
      "paystubs": 0.99
    }
  }
}