Get Company Information
curl --request GET \
--url https://api.example.com/v1/companies/{company_mapping_id}/import requests
url = "https://api.example.com/v1/companies/{company_mapping_id}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/companies/{company_mapping_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/companies/{company_mapping_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/companies/{company_mapping_id}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/companies/{company_mapping_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/companies/{company_mapping_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyCompanies & Data Providers
Get Company Information
Retrieve detailed information for a specific company mapping.
GET
/
v1
/
companies
/
{company_mapping_id}
/
Get Company Information
curl --request GET \
--url https://api.example.com/v1/companies/{company_mapping_id}/import requests
url = "https://api.example.com/v1/companies/{company_mapping_id}/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/companies/{company_mapping_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/companies/{company_mapping_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/companies/{company_mapping_id}/"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/companies/{company_mapping_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/companies/{company_mapping_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyOverview
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:| Header | Description |
|---|---|
X-Access-Client-Id | Your Client ID |
X-Access-Secret | Your Access Key |
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
company_mapping_id | string | Yes | Company to Payroll Provider mapping ID | c55a0d9f49554a60ad467d070b4e1ad0 |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
product_type | string | No | Product type for success rate calculation. Allowed values: income, employment, deposit_switch, pll |
Response
Success Response (HTTP 200)
| Field | Type | Description |
|---|---|---|
company_mapping_id | string | Company mapping ID |
name | string | Company name |
domain | string | Company domain |
logo_url | string (nullable) | URL to company logo |
success_rate | string | low, high, unsupported, or null |
confidence_level | string | Range 0 to 1; 0.5+ indicates high success rate |
mapping_status | string | verified, mapped, or unmapped |
Features Object
deposit_switch:| Field | Type | Description |
|---|---|---|
max_number | integer (nullable) | Maximum bank accounts allowed |
deposit_types | array | Supported types: entire, percent, amount |
amount_precision | integer | Precision level for amount allocations |
percent_precision | integer | Precision level for percentage allocations |
| Field | Description |
|---|---|
job_title | Job title availability rate |
job_type | Job type availability rate |
is_active | Active status availability rate |
start_date | Start date availability rate |
original_hire_date | Original hire date availability rate |
income | Income availability rate |
income_unit | Income unit availability rate |
pay_frequency | Pay frequency availability rate |
w2s | W-2 availability rate |
paystubs | Paystubs availability rate |
Error Responses
| Status Code | Description |
|---|---|
| 401 | Unauthorized - Missing or invalid authentication credentials |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not 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."
}