Create a data refresh task
curl --request POST \
--url https://prod.truv.com/v1/refresh/tasks/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"access_token": "48427a36d43c4d5aa6324bc06c692456",
"product_type": "income"
}
'import requests
url = "https://prod.truv.com/v1/refresh/tasks/"
payload = {
"access_token": "48427a36d43c4d5aa6324bc06c692456",
"product_type": "income"
}
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Access-Client-Id': '<api-key>',
'X-Access-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({access_token: '48427a36d43c4d5aa6324bc06c692456', product_type: 'income'})
};
fetch('https://prod.truv.com/v1/refresh/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/refresh/tasks/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'access_token' => '48427a36d43c4d5aa6324bc06c692456',
'product_type' => 'income'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod.truv.com/v1/refresh/tasks/"
payload := strings.NewReader("{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Client-Id", "<api-key>")
req.Header.Add("X-Access-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod.truv.com/v1/refresh/tasks/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/refresh/tasks/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "48427a36d43c4d5aa6324bc06c692456"
}{
"error": {
"code": "incorrect_parameters",
"message": "Incorrect request parameters",
"extra": {
"invalid-params": [
{
"field": "access_token",
"message": "This field is required."
}
]
}
}
}{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"error": {
"code": "throttled",
"message": "Request was throttled."
}
}Data Refresh
Create a data refresh task
The endpoint creates a link data refresh task.
POST
/
v1
/
refresh
/
tasks
/
Create a data refresh task
curl --request POST \
--url https://prod.truv.com/v1/refresh/tasks/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"access_token": "48427a36d43c4d5aa6324bc06c692456",
"product_type": "income"
}
'import requests
url = "https://prod.truv.com/v1/refresh/tasks/"
payload = {
"access_token": "48427a36d43c4d5aa6324bc06c692456",
"product_type": "income"
}
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Access-Client-Id': '<api-key>',
'X-Access-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({access_token: '48427a36d43c4d5aa6324bc06c692456', product_type: 'income'})
};
fetch('https://prod.truv.com/v1/refresh/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/refresh/tasks/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'access_token' => '48427a36d43c4d5aa6324bc06c692456',
'product_type' => 'income'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod.truv.com/v1/refresh/tasks/"
payload := strings.NewReader("{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Client-Id", "<api-key>")
req.Header.Add("X-Access-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod.truv.com/v1/refresh/tasks/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/refresh/tasks/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"48427a36d43c4d5aa6324bc06c692456\",\n \"product_type\": \"income\"\n}"
response = http.request(request)
puts response.read_body{
"task_id": "48427a36d43c4d5aa6324bc06c692456"
}{
"error": {
"code": "incorrect_parameters",
"message": "Incorrect request parameters",
"extra": {
"invalid-params": [
{
"field": "access_token",
"message": "This field is required."
}
]
}
}
}{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"error": {
"code": "throttled",
"message": "Request was throttled."
}
}Authorizations
Client ID
Client Access Key
Body
application/json
Link data refresh task
Refresh Link data task
Access token for a Link to payroll provider
Example:
"48427a36d43c4d5aa6324bc06c692456"
Indicates the type of product to use:
employment- Employment verification,income- Income and Employment verification,deposit_switch- Direct deposit switch,pll- Paycheck linked lending,insurance- Insurance verification,transactions- Financial account aggregation,assets- Assets verification,
Available options:
income, employment, deposit_switch, pll, insurance, transactions, assets Example:
"income"
Bank account info. Used for Paycheck Linked Loans
Show child attributes
Show child attributes
Response
Response for refresh task creation endpoint.
Unique ID for the Link data refresh task
Example:
"48427a36d43c4d5aa6324bc06c692456"
Was this page helpful?
⌘I