Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Companies and Data Providers

List all data providers

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

get/v1/providers/

Query parameters

data_source'payroll' | 'docs' | 'insurance' | 'financial_accounts' | 'tax' | 'scoring_attributes'
Example:payroll

Data source.

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets' required

Product type.

querystring

Search query by a name.

ordering'id' | '-id' | 'name' | '-name' | 'rank' | '-rank'
Example:id

Which field to use when ordering the results. The default is by ascending id.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

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