List all tasks

curl --request GET \
  --url https://prod.truv.com/v1/tasks/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'

import requests

url = "https://prod.truv.com/v1/tasks/"

headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};

fetch('https://prod.truv.com/v1/tasks/', 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://prod.truv.com/v1/tasks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Client-Id: <api-key>",
    "X-Access-Secret: <api-key>"
  ],
]);

$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://prod.truv.com/v1/tasks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/tasks/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/tasks/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "status": "done",
      "product_type": "income",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "logo_url": "https://cdn.truv.com/providers/adp.svg"
      },
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-07T15:30:00Z",
      "link_id": "48427a36d43c4d5aa6324bc06c692456",
      "user_id": "48427a36d43c4d5aa6324bc06c692456",
      "error_message": "Invalid credentials provided",
      "tracking_info": "0c8d444ff53947cd822efca7b3d9ef18",
      "bridge_token": "2f67984a110747d190c39e1022c81837",
      "data_source": "financial_accounts",
      "is_suspicious": false,
      "order_id": "48427a36d43c4d5aa6324bc06c692456"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

GET

tasks

List all tasks

curl --request GET \
  --url https://prod.truv.com/v1/tasks/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'

import requests

url = "https://prod.truv.com/v1/tasks/"

headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};

fetch('https://prod.truv.com/v1/tasks/', 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://prod.truv.com/v1/tasks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Client-Id: <api-key>",
    "X-Access-Secret: <api-key>"
  ],
]);

$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://prod.truv.com/v1/tasks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/tasks/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/tasks/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "status": "done",
      "product_type": "income",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "logo_url": "https://cdn.truv.com/providers/adp.svg"
      },
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-07T15:30:00Z",
      "link_id": "48427a36d43c4d5aa6324bc06c692456",
      "user_id": "48427a36d43c4d5aa6324bc06c692456",
      "error_message": "Invalid credentials provided",
      "tracking_info": "0c8d444ff53947cd822efca7b3d9ef18",
      "bridge_token": "2f67984a110747d190c39e1022c81837",
      "data_source": "financial_accounts",
      "is_suspicious": false,
      "order_id": "48427a36d43c4d5aa6324bc06c692456"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

Authorizations

X-Access-Client-Id

string

header

required

Client ID

X-Access-Secret

string

header

required

Client Access Key

Query Parameters

ordering

enum<string>

Which field to use when ordering the results. The default is by descending created_at.

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

status,

-status,

error_message,

-error_message,

provider_id,

-provider_id

Example:

"created_at"

created_at__lte

string<date-time>

Filter created_at less than or equal (ISO-8601).

created_at__gte

string<date-time>

Filter created_at greater than or equal (ISO-8601).

status

enum<string>

Filter by task status code.

Available options:

done,

error,

login_error,

account_locked,

mfa_error,

config_error,

no_data,

unavailable,

unable_to_reset,

not_supported

Example:

"done"

query

string

Search query by the following fields: id, link id, bridge token, order group id, tracking info.

provider

string

Filter by provider id.

product_type

enum<string>

Filter by product type.

Available options:

income,

employment,

deposit_switch,

pll,

insurance,

transactions,

assets

Example:

"income"

user_id

string

Filter by user id.

cursor

string

The pagination cursor value.

page_size

integer

Number of results to return per page.

Response

results

object[]

required

Show child attributes

string<uri> | null

Task Webhook Events Retrieve a task

⌘I