TRtruv
Companies and Data Providers

List all data providers

Changed on

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

get/v1/providers/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/providers/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

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.

category'gig' | 'benefits' | 'w2' | 'financial_institution' | 'insurance' | 'tax' | 'education'
Example:w2

Category of the provider.

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",
      "category": "w2"
    }
  ]
}

Changes

  • d7195c30b6b1Revision changes
    • info

      added the new optional query request parameter category

    • info

      added the optional property // to the response with the status

  • e58688835e25Revision changes
    • warning

      added the new credit enum value to the // response property for the response status

    • warning

      added the new education enum value to the // response property for the response status