Retrieve an order
curl --request GET \
--url https://prod.truv.com/v1/orders/{id}/ \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/orders/{id}/"
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/orders/{id}/', 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/orders/{id}/",
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/orders/{id}/"
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/orders/{id}/")
.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/orders/{id}/")
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{
"id": "39aa1486ccca4bc19cda071ffc1ba392",
"products": [
"income"
],
"source": "floify",
"order_number": "1534332",
"custom_field": "string",
"client_name": "Unnamed Verifications Inc.",
"first_name": "John",
"last_name": "Doe",
"user_id": "99dd17074ac94aa9ace2621d657c7610",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"share_url": "https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392",
"created_at": "2021-04-21T21:45:14.418542Z",
"updated_at": "2021-04-21T21:45:14.418542Z",
"canceled_at": "2021-04-22T21:45:14.418542Z",
"completed_at": "2021-04-22T21:45:14.418542Z",
"expired_at": "2021-04-24T21:45:14.418542Z",
"is_expired": true,
"user_consent_at": "2021-04-21T21:45:14.418542Z",
"initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
"refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
"employers": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "income",
"status": "pending",
"suborder_number": "133982343355",
"created_at": "2021-04-21T22:12:59.346109Z",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"link_id": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"data_source": "payroll",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"is_suspicious": true,
"start_date": "2019-08-24",
"end_date": "2019-11-27",
"company_name": "Facebook Demo",
"company_address": {
"street": "1 Hacker Way",
"city": "Menlo Park",
"state": "CA",
"zip": "94025"
},
"company_domain": "facebook.com",
"company_logo": "https://cdn.truv.com/company_logos/facebook.svg",
"employments": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"is_active": false,
"job_title": "PR associate",
"job_type": "F",
"income": "70000.00",
"income_unit": "YEARLY",
"pay_rate": "5833.33",
"pay_frequency": "M",
"start_date": "2018-01-01",
"end_date": "2026-04-23",
"original_hire_date": "2017-06-21",
"manager_name": "Jenny McDouglas",
"company": {
"name": "Facebook Demo",
"address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
},
"phone": "6503087300",
"ein": "770493581"
},
"profile": {
"id": "48427a36d43c4d5aa6324bc06c692456",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"email": "john.doe@example.com",
"date_of_birth": "1992-03-03",
"created_at": "2022-06-07T15:00:00Z",
"updated_at": "2022-06-30T15:00:00Z",
"middle_initials": "K",
"ssn": "123456789",
"home_address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
}
},
"statements": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"check_number": "29205182",
"pay_date": "2018-05-31",
"net_pay": "12915.44",
"net_pay_ytd": "39642.52",
"gross_pay": "18038.33",
"gross_pay_ytd": "55366.65",
"bonus": "100.00",
"commission": "12000.00",
"hours": "173.33",
"basis_of_pay": "S",
"period_start": "2018-05-01",
"period_end": "2018-05-31",
"regular": "5833.33",
"regular_ytd": "29166.65",
"other_pay_ytd": "700.00",
"bonus_ytd": "1000.00",
"commission_ytd": "24000.00",
"overtime": "45.00",
"overtime_ytd": "500.00",
"other_pay": "60.00",
"earnings": [
{
"name": "Regular",
"amount": "5833.33",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "45.00",
"category": "overtime",
"rate": "22.50",
"units": "2"
},
{
"name": "Commission",
"amount": "12000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "100.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "60.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"earnings_ytd": [
{
"name": "Regular",
"amount": "29166.65",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "500.00",
"category": "overtime",
"rate": null,
"units": null
},
{
"name": "Commission",
"amount": "24000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "1000.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "700.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"deductions": [
{
"name": "Federal Income Tax",
"amount": "2705.75",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "1118.38",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "261.56",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "1037.20",
"category": "state"
}
],
"deductions_ytd": [
{
"name": "Federal Income Tax",
"amount": "8305.00",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "3432.73",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "802.82",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "3183.58",
"category": "state"
}
],
"md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
"file": "https://cdn.truv.com/paystub_sample.pdf",
"derived_fields": [
"basis_of_pay"
],
"missing_data_fields": [
"earnings_ytd"
]
}
],
"annual_income_summary": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"year": 2018,
"regular": "29166.65",
"bonus": "1000.00",
"commission": "24000.00",
"overtime": "500.00",
"other_pay": "700.00",
"net_pay": "39642.52",
"gross_pay": "55366.65"
}
],
"bank_accounts": [
{
"account_number": "1234567890",
"routing_number": "123456789",
"account_name": "My Bank",
"account_type": "C",
"deposit_type": "A",
"deposit_value": "200.00",
"bank_name": "TD Bank"
}
],
"w2s": [
{
"file": "https://cdn.truv.com/W2_sample.pdf",
"md5sum": "f65e30c39124ad707ac4b3aeaee923a7",
"year": 2020,
"wages": "70000.00",
"federal_tax": "5830.87",
"social_security_wages": "70000.00",
"social_security_tax": "4340.00",
"medicare_wages": "70000.00",
"medicare_tax": "1015.00",
"gross_pay": "70000.00"
}
],
"external_last_updated": "2026-04-23",
"dates_from_statements": false,
"derived_fields": [
"is_active"
],
"missing_data_fields": [
"w2s"
],
"employed_in_role": "8 years 3 months"
}
],
"last_task_status": "done"
}
],
"insurance": {
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "insurance",
"status": "pending",
"created_at": "2021-04-21T22:12:59.346109Z",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"is_suspicious": true,
"provider_id": "geico",
"suborder_number": "133982343355",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"link_id": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"data_source": "insurance",
"last_task_status": "done"
},
"manager": {
"email": "john.doe@example.com",
"name": "John Doe"
},
"financial_accounts": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "transactions",
"status": "pending",
"created_at": "2021-04-21T22:12:59.346109Z",
"link_id": "e4100fccdae94691b4414c7306220c06",
"data_source": "financial_accounts",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"type": "CHECKING",
"subtype": "MONEY_MARKET",
"mask": "6789",
"balance": "5000.00",
"owners": [
{
"full_name": "John Doe"
}
]
}
],
"bank_income_sources": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
"income_description": "Paycheck",
"income_category": "PAYCHECK",
"pay_frequency": "SM",
"total_amount": "200.31",
"iso_currency_code": "USD",
"transaction_count": 1,
"historical_summary": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"total_amount": "200.31",
"iso_currency_code": "USD",
"transactions": [
{
"amount": "200.31",
"iso_currency_code": "USD",
"date": "2022-05-04",
"description": "string",
"pending": true,
"transaction_id": "7d4fcb86b81a4880955beea558092391",
"check_number": null
}
]
}
],
"avg_deposit_amount": "5000.00",
"next_payment_date": "2022-06-01",
"historical_average_monthly_income": "10000.00",
"historical_average_monthly_gross_income": "12000.00",
"forecasted_average_monthly_income": "10000.00",
"avg_gross_deposit_amount": "6000.00",
"employer": {
"id": "meta",
"name": "Meta",
"logo_url": null
}
}
],
"suborder_number": "133982343355",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"is_suspicious": true,
"last_task_status": "done"
}
],
"template_id": "9b96606355b94e8abff8ed8d75aa2027",
"short_share_url": "https://truv.com/s/BIlEyh1A",
"voie_report_id": "b19c454a98594b4084b71e3b62873d29",
"voa_report_id": "b19c454a98594b4084b71e3b62873d29",
"income_insights_report_id": "b19c454a98594b4084b71e3b62873d29",
"notes": "To be processed by John Doe",
"loan": {
"loan_number": "MUUT220700012",
"application_number": "APP-2207-0001",
"originator_name": "John Doe",
"originator_email": "john@example.com",
"loan_processor_name": "John Doe",
"loan_processor_email": "john@doe.com",
"external_id": "c505e0f1b4134fdc853fc87e7d2cc4a5"
},
"cc_emails": [
"user@example.com"
],
"aim_check_report_id": "FM-1234-39aa1486ccca4bc19cda071ffc1ba392"
}Orders
Retrieve an order
The endpoint returns the order.
GET
/
v1
/
orders
/
{id}
/
Retrieve an order
curl --request GET \
--url https://prod.truv.com/v1/orders/{id}/ \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/orders/{id}/"
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/orders/{id}/', 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/orders/{id}/",
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/orders/{id}/"
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/orders/{id}/")
.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/orders/{id}/")
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{
"id": "39aa1486ccca4bc19cda071ffc1ba392",
"products": [
"income"
],
"source": "floify",
"order_number": "1534332",
"custom_field": "string",
"client_name": "Unnamed Verifications Inc.",
"first_name": "John",
"last_name": "Doe",
"user_id": "99dd17074ac94aa9ace2621d657c7610",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"share_url": "https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392",
"created_at": "2021-04-21T21:45:14.418542Z",
"updated_at": "2021-04-21T21:45:14.418542Z",
"canceled_at": "2021-04-22T21:45:14.418542Z",
"completed_at": "2021-04-22T21:45:14.418542Z",
"expired_at": "2021-04-24T21:45:14.418542Z",
"is_expired": true,
"user_consent_at": "2021-04-21T21:45:14.418542Z",
"initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
"refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
"employers": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "income",
"status": "pending",
"suborder_number": "133982343355",
"created_at": "2021-04-21T22:12:59.346109Z",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"link_id": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"data_source": "payroll",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"is_suspicious": true,
"start_date": "2019-08-24",
"end_date": "2019-11-27",
"company_name": "Facebook Demo",
"company_address": {
"street": "1 Hacker Way",
"city": "Menlo Park",
"state": "CA",
"zip": "94025"
},
"company_domain": "facebook.com",
"company_logo": "https://cdn.truv.com/company_logos/facebook.svg",
"employments": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"is_active": false,
"job_title": "PR associate",
"job_type": "F",
"income": "70000.00",
"income_unit": "YEARLY",
"pay_rate": "5833.33",
"pay_frequency": "M",
"start_date": "2018-01-01",
"end_date": "2026-04-23",
"original_hire_date": "2017-06-21",
"manager_name": "Jenny McDouglas",
"company": {
"name": "Facebook Demo",
"address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
},
"phone": "6503087300",
"ein": "770493581"
},
"profile": {
"id": "48427a36d43c4d5aa6324bc06c692456",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"email": "john.doe@example.com",
"date_of_birth": "1992-03-03",
"created_at": "2022-06-07T15:00:00Z",
"updated_at": "2022-06-30T15:00:00Z",
"middle_initials": "K",
"ssn": "123456789",
"home_address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
}
},
"statements": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"check_number": "29205182",
"pay_date": "2018-05-31",
"net_pay": "12915.44",
"net_pay_ytd": "39642.52",
"gross_pay": "18038.33",
"gross_pay_ytd": "55366.65",
"bonus": "100.00",
"commission": "12000.00",
"hours": "173.33",
"basis_of_pay": "S",
"period_start": "2018-05-01",
"period_end": "2018-05-31",
"regular": "5833.33",
"regular_ytd": "29166.65",
"other_pay_ytd": "700.00",
"bonus_ytd": "1000.00",
"commission_ytd": "24000.00",
"overtime": "45.00",
"overtime_ytd": "500.00",
"other_pay": "60.00",
"earnings": [
{
"name": "Regular",
"amount": "5833.33",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "45.00",
"category": "overtime",
"rate": "22.50",
"units": "2"
},
{
"name": "Commission",
"amount": "12000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "100.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "60.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"earnings_ytd": [
{
"name": "Regular",
"amount": "29166.65",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "500.00",
"category": "overtime",
"rate": null,
"units": null
},
{
"name": "Commission",
"amount": "24000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "1000.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "700.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"deductions": [
{
"name": "Federal Income Tax",
"amount": "2705.75",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "1118.38",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "261.56",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "1037.20",
"category": "state"
}
],
"deductions_ytd": [
{
"name": "Federal Income Tax",
"amount": "8305.00",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "3432.73",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "802.82",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "3183.58",
"category": "state"
}
],
"md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
"file": "https://cdn.truv.com/paystub_sample.pdf",
"derived_fields": [
"basis_of_pay"
],
"missing_data_fields": [
"earnings_ytd"
]
}
],
"annual_income_summary": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"year": 2018,
"regular": "29166.65",
"bonus": "1000.00",
"commission": "24000.00",
"overtime": "500.00",
"other_pay": "700.00",
"net_pay": "39642.52",
"gross_pay": "55366.65"
}
],
"bank_accounts": [
{
"account_number": "1234567890",
"routing_number": "123456789",
"account_name": "My Bank",
"account_type": "C",
"deposit_type": "A",
"deposit_value": "200.00",
"bank_name": "TD Bank"
}
],
"w2s": [
{
"file": "https://cdn.truv.com/W2_sample.pdf",
"md5sum": "f65e30c39124ad707ac4b3aeaee923a7",
"year": 2020,
"wages": "70000.00",
"federal_tax": "5830.87",
"social_security_wages": "70000.00",
"social_security_tax": "4340.00",
"medicare_wages": "70000.00",
"medicare_tax": "1015.00",
"gross_pay": "70000.00"
}
],
"external_last_updated": "2026-04-23",
"dates_from_statements": false,
"derived_fields": [
"is_active"
],
"missing_data_fields": [
"w2s"
],
"employed_in_role": "8 years 3 months"
}
],
"last_task_status": "done"
}
],
"insurance": {
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "insurance",
"status": "pending",
"created_at": "2021-04-21T22:12:59.346109Z",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"is_suspicious": true,
"provider_id": "geico",
"suborder_number": "133982343355",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"link_id": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"data_source": "insurance",
"last_task_status": "done"
},
"manager": {
"email": "john.doe@example.com",
"name": "John Doe"
},
"financial_accounts": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "transactions",
"status": "pending",
"created_at": "2021-04-21T22:12:59.346109Z",
"link_id": "e4100fccdae94691b4414c7306220c06",
"data_source": "financial_accounts",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"type": "CHECKING",
"subtype": "MONEY_MARKET",
"mask": "6789",
"balance": "5000.00",
"owners": [
{
"full_name": "John Doe"
}
]
}
],
"bank_income_sources": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
"income_description": "Paycheck",
"income_category": "PAYCHECK",
"pay_frequency": "SM",
"total_amount": "200.31",
"iso_currency_code": "USD",
"transaction_count": 1,
"historical_summary": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"total_amount": "200.31",
"iso_currency_code": "USD",
"transactions": [
{
"amount": "200.31",
"iso_currency_code": "USD",
"date": "2022-05-04",
"description": "string",
"pending": true,
"transaction_id": "7d4fcb86b81a4880955beea558092391",
"check_number": null
}
]
}
],
"avg_deposit_amount": "5000.00",
"next_payment_date": "2022-06-01",
"historical_average_monthly_income": "10000.00",
"historical_average_monthly_gross_income": "12000.00",
"forecasted_average_monthly_income": "10000.00",
"avg_gross_deposit_amount": "6000.00",
"employer": {
"id": "meta",
"name": "Meta",
"logo_url": null
}
}
],
"suborder_number": "133982343355",
"bridge_token": "e4100fccdae94691b4414c7306220c06",
"access_token": "e4100fccdae94691b4414c7306220c06",
"pdf_report": "https://cdn.truv.com/report.pdf",
"is_suspicious": true,
"last_task_status": "done"
}
],
"template_id": "9b96606355b94e8abff8ed8d75aa2027",
"short_share_url": "https://truv.com/s/BIlEyh1A",
"voie_report_id": "b19c454a98594b4084b71e3b62873d29",
"voa_report_id": "b19c454a98594b4084b71e3b62873d29",
"income_insights_report_id": "b19c454a98594b4084b71e3b62873d29",
"notes": "To be processed by John Doe",
"loan": {
"loan_number": "MUUT220700012",
"application_number": "APP-2207-0001",
"originator_name": "John Doe",
"originator_email": "john@example.com",
"loan_processor_name": "John Doe",
"loan_processor_email": "john@doe.com",
"external_id": "c505e0f1b4134fdc853fc87e7d2cc4a5"
},
"cc_emails": [
"user@example.com"
],
"aim_check_report_id": "FM-1234-39aa1486ccca4bc19cda071ffc1ba392"
}Authorizations
Client ID
Client Access Key
Path Parameters
Order ID received from the POST request
Query Parameters
Controls whether income certification data is included in the response. When provided, each employment, account, and income source in the response is annotated with a certification object containing the certification decision, rejection reason, rejection comment, and certified data fields. Additionally, the response includes additional_income_sources derived from individually certified bank deposits (e.g., gig income) that are not associated with a recognized income source. When omitted, the response does not include any certification-related fields.
Available options:
all, certified Example:
"all"
Response
- Order
- Order with certification
Unique ID
Maximum string length:
32Example:
"39aa1486ccca4bc19cda071ffc1ba392"
Types of products selected for the order
Available options:
income, employment, deposit_switch, pll, insurance, transactions, assets Example:
["income"]
Type of the platform (internal, accio, etc.)
Available options:
floify, besmartee, lenderlogix, encompass_consumer_connect, byte, core_logic, xactus, constellation, banno, mx, q2, clutch, accio, encompass, tpo_connect, darkmatter, tazworks, internal, simplenexus, external_webpage, individual, alkami, blue_sage, lodasoft, blend, tidalwave, self_signup Example:
"floify"
Client name displayed on the order page
Maximum string length:
255Example:
"Unnamed Verifications Inc."
First name
Maximum string length:
50Example:
"John"
Last name
Maximum string length:
50Example:
"Doe"
Unique Truv ID of the user.
Maximum string length:
32Example:
"99dd17074ac94aa9ace2621d657c7610"
Landing page URL to share
Maximum string length:
512Example:
"https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392"
Date and time when order was created
Example:
"2021-04-21T21:45:14.418542Z"
Date and time when order would expire
Example:
"2021-04-24T21:45:14.418542Z"
If order is already expired
List of employers
Show child attributes
Show child attributes
List of financial accounts
Show child attributes
Show child attributes
External ID
Maximum string length:
512Example:
"1534332"
User provided custom field. Must be enabled in the customization section.
UUID value of bridge token
Maximum string length:
32Example:
"e4100fccdae94691b4414c7306220c06"
Date and time when order was updated
Example:
"2021-04-21T21:45:14.418542Z"
Date and time when order was canceled
Example:
"2021-04-22T21:45:14.418542Z"
Date and time when order was successfully completed
Example:
"2021-04-22T21:45:14.418542Z"
Date and time when explicit user consent was given
Example:
"2021-04-21T21:45:14.418542Z"
ID of an origin order if the order was created by the order data refresh operation
Example:
"f5dc0239e2094dbc90ab2edc1918a9df"
ID of the last refresh order created by the order data refresh operation for the order
Example:
"9b96606355b94e8abff8ed8d75aa2027"
Insurance verification meta data
Show child attributes
Show child attributes
Order manager info associated with an order.
Show child attributes
Show child attributes
Loan Information
- Option 1
- Option 2
Show child attributes
Show child attributes
ID of the template
Maximum string length:
32Example:
"9b96606355b94e8abff8ed8d75aa2027"
A list of email addresses that will receive carbon copies (CC) of order status updates.
Maximum array length:
15Shortened verification URL to share
Maximum string length:
512Example:
"https://truv.com/s/BIlEyh1A"
GSE accepted income and employment verification report ID
Maximum string length:
32Example:
"b19c454a98594b4084b71e3b62873d29"
Verification of Assets report ID
Maximum string length:
32Example:
"b19c454a98594b4084b71e3b62873d29"
Income Insights report ID
Maximum string length:
32Example:
"b19c454a98594b4084b71e3b62873d29"
AIM check report ID
Maximum string length:
64Example:
"FM-1234-39aa1486ccca4bc19cda071ffc1ba392"
Free text field for notes associated with the order
Required string length:
1 - 2000Example:
"To be processed by John Doe"
Was this page helpful?