Create a customization template
curl --request POST \
--url https://prod.truv.com/v1/templates/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"name": "My template",
"products": [
"income"
],
"default_for_products": true,
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": true,
"large_deposits": true,
"historical_payment_summary": true
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
],
"transaction_account_types": [
"CHECKING",
"SAVINGS"
],
"transaction_account_subtypes": [
"FIXED_ANNUITY",
"LOCKED_IN_RETIREMENT_ACCOUNT",
"PLAN_401_A"
],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"income": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"insurance": {
"flow": "fallback",
"data_sources": [
"insurance"
]
}
}
}
'import requests
url = "https://prod.truv.com/v1/templates/"
payload = {
"name": "My template",
"products": ["income"],
"default_for_products": True,
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": True,
"large_deposits": True,
"historical_payment_summary": True
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": ["Food & Dining", "Travel", "Shopping"],
"transaction_account_types": ["CHECKING", "SAVINGS"],
"transaction_account_subtypes": ["FIXED_ANNUITY", "LOCKED_IN_RETIREMENT_ACCOUNT", "PLAN_401_A"],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": ["Food & Dining", "Travel", "Shopping"]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": ["payroll"]
},
"income": {
"flow": "fallback",
"data_sources": ["payroll"]
},
"insurance": {
"flow": "fallback",
"data_sources": ["insurance"]
}
}
}
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({
name: 'My template',
products: ['income'],
default_for_products: true,
bridge: {},
branding: {},
orders: {},
document_upload: {},
data: {},
reports: {
hidden_sections: {deposits: true, large_deposits: true, historical_payment_summary: true},
days_requested: 60,
large_deposit_threshold: 500,
transaction_categories: ['Food & Dining', 'Travel', 'Shopping'],
transaction_account_types: ['CHECKING', 'SAVINGS'],
transaction_account_subtypes: ['FIXED_ANNUITY', 'LOCKED_IN_RETIREMENT_ACCOUNT', 'PLAN_401_A'],
income_insights: {
days_requested: 60,
consumer_report_permissible_purpose: 'WRITTEN_INSTRUCTION_OTHER'
},
labeled_transaction_categories: ['Food & Dining', 'Travel', 'Shopping']
},
data_sources_flow: {
employment: {flow: 'fallback', data_sources: ['payroll']},
income: {flow: 'fallback', data_sources: ['payroll']},
insurance: {flow: 'fallback', data_sources: ['insurance']}
}
})
};
fetch('https://prod.truv.com/v1/templates/', 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/templates/",
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([
'name' => 'My template',
'products' => [
'income'
],
'default_for_products' => true,
'bridge' => [
],
'branding' => [
],
'orders' => [
],
'document_upload' => [
],
'data' => [
],
'reports' => [
'hidden_sections' => [
'deposits' => true,
'large_deposits' => true,
'historical_payment_summary' => true
],
'days_requested' => 60,
'large_deposit_threshold' => 500,
'transaction_categories' => [
'Food & Dining',
'Travel',
'Shopping'
],
'transaction_account_types' => [
'CHECKING',
'SAVINGS'
],
'transaction_account_subtypes' => [
'FIXED_ANNUITY',
'LOCKED_IN_RETIREMENT_ACCOUNT',
'PLAN_401_A'
],
'income_insights' => [
'days_requested' => 60,
'consumer_report_permissible_purpose' => 'WRITTEN_INSTRUCTION_OTHER'
],
'labeled_transaction_categories' => [
'Food & Dining',
'Travel',
'Shopping'
]
],
'data_sources_flow' => [
'employment' => [
'flow' => 'fallback',
'data_sources' => [
'payroll'
]
],
'income' => [
'flow' => 'fallback',
'data_sources' => [
'payroll'
]
],
'insurance' => [
'flow' => 'fallback',
'data_sources' => [
'insurance'
]
]
]
]),
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/templates/"
payload := strings.NewReader("{\n \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\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/templates/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/templates/")
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 \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "48427a36d43c4d5aa6324bc06c692456",
"name": "My template",
"products": [
"income"
],
"default_for_products": true,
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": true,
"large_deposits": true,
"historical_payment_summary": true
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
],
"transaction_account_types": [
"CHECKING",
"SAVINGS"
],
"transaction_account_subtypes": [
"FIXED_ANNUITY",
"LOCKED_IN_RETIREMENT_ACCOUNT",
"PLAN_401_A"
],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"income": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"insurance": {
"flow": "fallback",
"data_sources": [
"insurance"
]
}
}
}{
"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."
}
}UX Customization
Create a customization template
The endpoint creates a customization template.
POST
/
v1
/
templates
/
Create a customization template
curl --request POST \
--url https://prod.truv.com/v1/templates/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"name": "My template",
"products": [
"income"
],
"default_for_products": true,
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": true,
"large_deposits": true,
"historical_payment_summary": true
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
],
"transaction_account_types": [
"CHECKING",
"SAVINGS"
],
"transaction_account_subtypes": [
"FIXED_ANNUITY",
"LOCKED_IN_RETIREMENT_ACCOUNT",
"PLAN_401_A"
],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"income": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"insurance": {
"flow": "fallback",
"data_sources": [
"insurance"
]
}
}
}
'import requests
url = "https://prod.truv.com/v1/templates/"
payload = {
"name": "My template",
"products": ["income"],
"default_for_products": True,
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": True,
"large_deposits": True,
"historical_payment_summary": True
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": ["Food & Dining", "Travel", "Shopping"],
"transaction_account_types": ["CHECKING", "SAVINGS"],
"transaction_account_subtypes": ["FIXED_ANNUITY", "LOCKED_IN_RETIREMENT_ACCOUNT", "PLAN_401_A"],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": ["Food & Dining", "Travel", "Shopping"]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": ["payroll"]
},
"income": {
"flow": "fallback",
"data_sources": ["payroll"]
},
"insurance": {
"flow": "fallback",
"data_sources": ["insurance"]
}
}
}
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({
name: 'My template',
products: ['income'],
default_for_products: true,
bridge: {},
branding: {},
orders: {},
document_upload: {},
data: {},
reports: {
hidden_sections: {deposits: true, large_deposits: true, historical_payment_summary: true},
days_requested: 60,
large_deposit_threshold: 500,
transaction_categories: ['Food & Dining', 'Travel', 'Shopping'],
transaction_account_types: ['CHECKING', 'SAVINGS'],
transaction_account_subtypes: ['FIXED_ANNUITY', 'LOCKED_IN_RETIREMENT_ACCOUNT', 'PLAN_401_A'],
income_insights: {
days_requested: 60,
consumer_report_permissible_purpose: 'WRITTEN_INSTRUCTION_OTHER'
},
labeled_transaction_categories: ['Food & Dining', 'Travel', 'Shopping']
},
data_sources_flow: {
employment: {flow: 'fallback', data_sources: ['payroll']},
income: {flow: 'fallback', data_sources: ['payroll']},
insurance: {flow: 'fallback', data_sources: ['insurance']}
}
})
};
fetch('https://prod.truv.com/v1/templates/', 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/templates/",
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([
'name' => 'My template',
'products' => [
'income'
],
'default_for_products' => true,
'bridge' => [
],
'branding' => [
],
'orders' => [
],
'document_upload' => [
],
'data' => [
],
'reports' => [
'hidden_sections' => [
'deposits' => true,
'large_deposits' => true,
'historical_payment_summary' => true
],
'days_requested' => 60,
'large_deposit_threshold' => 500,
'transaction_categories' => [
'Food & Dining',
'Travel',
'Shopping'
],
'transaction_account_types' => [
'CHECKING',
'SAVINGS'
],
'transaction_account_subtypes' => [
'FIXED_ANNUITY',
'LOCKED_IN_RETIREMENT_ACCOUNT',
'PLAN_401_A'
],
'income_insights' => [
'days_requested' => 60,
'consumer_report_permissible_purpose' => 'WRITTEN_INSTRUCTION_OTHER'
],
'labeled_transaction_categories' => [
'Food & Dining',
'Travel',
'Shopping'
]
],
'data_sources_flow' => [
'employment' => [
'flow' => 'fallback',
'data_sources' => [
'payroll'
]
],
'income' => [
'flow' => 'fallback',
'data_sources' => [
'payroll'
]
],
'insurance' => [
'flow' => 'fallback',
'data_sources' => [
'insurance'
]
]
]
]),
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/templates/"
payload := strings.NewReader("{\n \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\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/templates/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/templates/")
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 \"name\": \"My template\",\n \"products\": [\n \"income\"\n ],\n \"default_for_products\": true,\n \"bridge\": {},\n \"branding\": {},\n \"orders\": {},\n \"document_upload\": {},\n \"data\": {},\n \"reports\": {\n \"hidden_sections\": {\n \"deposits\": true,\n \"large_deposits\": true,\n \"historical_payment_summary\": true\n },\n \"days_requested\": 60,\n \"large_deposit_threshold\": 500,\n \"transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ],\n \"transaction_account_types\": [\n \"CHECKING\",\n \"SAVINGS\"\n ],\n \"transaction_account_subtypes\": [\n \"FIXED_ANNUITY\",\n \"LOCKED_IN_RETIREMENT_ACCOUNT\",\n \"PLAN_401_A\"\n ],\n \"income_insights\": {\n \"days_requested\": 60,\n \"consumer_report_permissible_purpose\": \"WRITTEN_INSTRUCTION_OTHER\"\n },\n \"labeled_transaction_categories\": [\n \"Food & Dining\",\n \"Travel\",\n \"Shopping\"\n ]\n },\n \"data_sources_flow\": {\n \"employment\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"income\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"payroll\"\n ]\n },\n \"insurance\": {\n \"flow\": \"fallback\",\n \"data_sources\": [\n \"insurance\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "48427a36d43c4d5aa6324bc06c692456",
"name": "My template",
"products": [
"income"
],
"default_for_products": true,
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"bridge": {},
"branding": {},
"orders": {},
"document_upload": {},
"data": {},
"reports": {
"hidden_sections": {
"deposits": true,
"large_deposits": true,
"historical_payment_summary": true
},
"days_requested": 60,
"large_deposit_threshold": 500,
"transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
],
"transaction_account_types": [
"CHECKING",
"SAVINGS"
],
"transaction_account_subtypes": [
"FIXED_ANNUITY",
"LOCKED_IN_RETIREMENT_ACCOUNT",
"PLAN_401_A"
],
"income_insights": {
"days_requested": 60,
"consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
},
"labeled_transaction_categories": [
"Food & Dining",
"Travel",
"Shopping"
]
},
"data_sources_flow": {
"employment": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"income": {
"flow": "fallback",
"data_sources": [
"payroll"
]
},
"insurance": {
"flow": "fallback",
"data_sources": [
"insurance"
]
}
}
}{
"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."
}
}Authorizations
Client ID
Client Access Key
Body
application/json
Template name
Maximum string length:
128Products list this template applies to
Available options:
income, employment, deposit_switch, pll, insurance, transactions, assets, education If enabled, the template will be applied for the products by default
Settings for bridge
Show child attributes
Show child attributes
Settings for branding
Show child attributes
Show child attributes
Settings for orders
Show child attributes
Show child attributes
Settings for document upload.
When the other document type is enabled, end users can upload arbitrary documents that don't fit the other categories. Truv does not parse these documents into structured data (they are captured only) — you can collect the uploaded files through the Uploaded Documents API (GET /v1/links/{link_id}/documents/).
Show child attributes
Show child attributes
Settings for returned documents data
Show child attributes
Show child attributes
Settings for reports
Show child attributes
Show child attributes
Data sources and flow configuration per product type. Supported product keys: employment, income, insurance.
Show child attributes
Show child attributes
Response
Unique identifier of the template.
Maximum string length:
32Example:
"48427a36d43c4d5aa6324bc06c692456"
Template name
Maximum string length:
128Products list this template applies to
Available options:
income, employment, deposit_switch, pll, insurance, transactions, assets, education If enabled, the template will be applied for the products by default
Timestamp when the template was created.
Example:
"2022-05-04T11:30:00Z"
Timestamp when the template was updated last time.
Example:
"2022-05-04T12:00:00Z"
Settings for bridge
Show child attributes
Show child attributes
Settings for branding
Show child attributes
Show child attributes
Settings for orders
Show child attributes
Show child attributes
Settings for document upload.
When the other document type is enabled, end users can upload arbitrary documents that don't fit the other categories. Truv does not parse these documents into structured data (they are captured only) — you can collect the uploaded files through the Uploaded Documents API (GET /v1/links/{link_id}/documents/).
Show child attributes
Show child attributes
Settings for returned documents data
Show child attributes
Show child attributes
Settings for reports
Show child attributes
Show child attributes
Data sources and flow configuration per product type. Supported product keys: employment, income, insurance.
Show child attributes
Show child attributes
Was this page helpful?