Skip to main content
GET
/
v1
/
companies
/
{company_mapping_id}
Get Company Information
curl --request GET \
  --url https://api.example.com/v1/companies/{company_mapping_id}/

​
Overview

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

​
Request

​
Endpoint

GET https://prod.transcrypts.com/v1/companies/{company_mapping_id}/

​
Authentication

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

​
Path Parameters

ParameterTypeRequiredDescriptionExample
company_mapping_idstringYesCompany to Payroll Provider mapping IDc55a0d9f49554a60ad467d070b4e1ad0

​
Query Parameters

ParameterTypeRequiredDescription
product_typestringNoProduct type for success rate calculation. Allowed values: income, employment, deposit_switch, pll

​
Response

​
Success Response (HTTP 200)

FieldTypeDescription
company_mapping_idstringCompany mapping ID
namestringCompany name
domainstringCompany domain
logo_urlstring (nullable)URL to company logo
success_ratestringlow, high, unsupported, or null
confidence_levelstringRange 0 to 1; 0.5+ indicates high success rate
mapping_statusstringverified, mapped, or unmapped

​
Features Object

deposit_switch:
FieldTypeDescription
max_numberinteger (nullable)Maximum bank accounts allowed
deposit_typesarraySupported types: entire, percent, amount
amount_precisionintegerPrecision level for amount allocations
percent_precisionintegerPrecision level for percentage allocations
fill_rates: Data availability rates (0 to 1 scale):
FieldDescription
job_titleJob title availability rate
job_typeJob type availability rate
is_activeActive status availability rate
start_dateStart date availability rate
original_hire_dateOriginal hire date availability rate
incomeIncome availability rate
income_unitIncome unit availability rate
pay_frequencyPay frequency availability rate
w2sW-2 availability rate
paystubsPaystubs availability rate

​
Error Responses

Status CodeDescription
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions
404Not Found - Company mapping does not exist

​
Example Error Response (401)

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

​
Example Error Response (404)

{
  "detail": "Not Found."
}