Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Companies and Data Providers

Retrieve a data provider

This endpoint retrieves a data provider.

get/v1/providers/{id}/

Query parameters

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets'
Example:income

Product type

Response

idstring required

ID of provider

namestring required

Data provider name

data_source'payroll' | 'docs' | 'insurance' | 'financial_accounts' | 'tax' | 'scoring_attributes' | 'credit' | 'education'

Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.

logo_urlstring uri

Data provider logo URL

is_disabledboolean

True if product type for the query parameter product_type not implemented for the provider yet. If product_type query parameter is omitted the field will be null.

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

Success rate for the provider

is_oauthboolean

Whether the provider has OAuth authentication enabled.

urlstring uri

The provider's website URL.

Example response

{
  "id": "adp",
  "name": "ADP",
  "data_source": "payroll",
  "logo_url": "https://cdn.truv.com/providers/adp.svg",
  "success_rate": "high",
  "url": "https://www.adp.com/"
}