List orders
curl --request GET \
--url https://prod.truv.com/v1/orders/ \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/orders/"
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/', 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/",
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/"
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/")
.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/")
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{
"next": "https://prod.truv.com/v1/orders/?cursor=cD0yMDI2LTA0LTIx",
"previous": null,
"results": [
{
"id": "39aa1486ccca4bc19cda071ffc1ba392",
"user_id": "99dd17074ac94aa9ace2621d657c7610",
"order_number": "1534332",
"products": [
"income",
"assets"
],
"source": "floify",
"custom_field": null,
"first_name": "John",
"last_name": "Doe",
"short_share_url": "https://truv.com/s/BIlEyh1A",
"created_at": "2026-04-21T21:45:14.418542Z",
"canceled_at": null,
"expired_at": "2026-04-23T21:45:14.418542Z",
"initial_order": null,
"refresh_order": null,
"manager": {
"email": "john.doe@example.com",
"name": "John Doe"
},
"template": {
"id": "9b96606355b94e8abff8ed8d75aa2027",
"name": "My template"
},
"notes": "To be processed by John Doe",
"employers": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "income",
"status": "completed",
"suborder_number": "133982343355",
"created_at": "2026-04-21T22:12:59.346109Z",
"data_source": "payroll",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"link_id": "e4100fccdae94691b4414c7306220c06",
"is_suspicious": true,
"was_attempted": true
}
],
"insurance": null,
"financial_accounts": null,
"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"
}
}
]
}Orders
List orders
The endpoint returns a list of orders.
GET
/
v1
/
orders
/
List orders
curl --request GET \
--url https://prod.truv.com/v1/orders/ \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/orders/"
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/', 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/",
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/"
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/")
.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/")
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{
"next": "https://prod.truv.com/v1/orders/?cursor=cD0yMDI2LTA0LTIx",
"previous": null,
"results": [
{
"id": "39aa1486ccca4bc19cda071ffc1ba392",
"user_id": "99dd17074ac94aa9ace2621d657c7610",
"order_number": "1534332",
"products": [
"income",
"assets"
],
"source": "floify",
"custom_field": null,
"first_name": "John",
"last_name": "Doe",
"short_share_url": "https://truv.com/s/BIlEyh1A",
"created_at": "2026-04-21T21:45:14.418542Z",
"canceled_at": null,
"expired_at": "2026-04-23T21:45:14.418542Z",
"initial_order": null,
"refresh_order": null,
"manager": {
"email": "john.doe@example.com",
"name": "John Doe"
},
"template": {
"id": "9b96606355b94e8abff8ed8d75aa2027",
"name": "My template"
},
"notes": "To be processed by John Doe",
"employers": [
{
"id": "ad9f14440d624ec3b0f66e81e44518c7",
"product_type": "income",
"status": "completed",
"suborder_number": "133982343355",
"created_at": "2026-04-21T22:12:59.346109Z",
"data_source": "payroll",
"provider": {
"id": "truv_api",
"name": "Sandbox Provider",
"logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
},
"link_id": "e4100fccdae94691b4414c7306220c06",
"is_suspicious": true,
"was_attempted": true
}
],
"insurance": null,
"financial_accounts": null,
"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"
}
}
]
}Authorizations
Client ID
Client Access Key
Query Parameters
Filter created_at less than or equal (ISO-8601).
Filter created_at greater than or equal (ISO-8601).
Filter expired_at less than or equal (ISO-8601).
Filter expired_at greater than or equal (ISO-8601).
Filter by order source.
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, self_signup, alkami, blue_sage, lodasoft, blend, tidalwave Example:
"floify"
Filter by order status.
Available options:
pending, sent, completed, error, canceled, expired, no_data, skipped Example:
["completed"]
Filter by product type.
Available options:
income, employment, deposit_switch, pll, insurance, transactions, assets, credit Example:
["income", "assets"]
Filter refresh orders: only returns refresh orders, exclude returns original orders.
Available options:
only, exclude Example:
"exclude"
Comma-separated list of order manager emails to filter orders.
Comma-separated list of customization template IDs to filter orders.
Filter orders by user ID.
Example:
"99dd17074ac94aa9ace2621d657c7610"
When set to true, returns only the most recent order per user.
Search query by the following fields: id, applicant_report_id, voa_report_id, phone, email, order_number, loan_number, application_number, custom_field, first_name, last_name, company_name.
Which field to use when ordering the results. The default is by descending created_at.
Available options:
created_at, -created_at, refreshed_at, -refreshed_at, expired_at, -expired_at, order_number, -order_number, order_manager__email, -order_manager__email, notes, -notes Example:
"-created_at"
The pagination cursor value.
Number of results to return per page.
Required range:
1 <= x <= 50Response
- Orders
- Latest per user
Was this page helpful?