Skip to main content
GET
/
v1
/
providers
List All Data Providers
curl --request GET \
  --url https://api.example.com/v1/providers/

​
Overview

The endpoint returns a list of data providers filtered by the query parameter product_type.

​
Request

​
Endpoint

GET https://prod.transcrypts.com/v1/providers/

​
Authentication

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

​
Query Parameters

ParameterTypeRequiredDescription
product_typestringNoFilter by product type. Allowed values: employment, income, deposit_switch, pll, insurance, financial_accounts, assets

​
Response

​
Success Response (HTTP 200)

The endpoint returns a JSON array of provider objects. 
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "ADP",
    "is_supported": true
  },
  {
    "id": "4fb96g75-6828-5673-c4gd-3d074g77bgb7",
    "name": "Gusto",
    "is_supported": true
  }
]

​
Response Fields

FieldTypeDescription
idstringData provider unique ID
namestringData provider name
is_supportedbooleanSupport status for the specified product

​
Error Responses

Status CodeDescription
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions