Update an order
curl --request PATCH \
--url https://prod.truv.com/v1/orders/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"refresh_approved": true,
"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",
"funding_date": "2024-08-24"
},
"notes": "<string>",
"notification_settings": {
"suppress_user_notifications": false,
"first_notification_delay_hours": 0
}
}
'import requests
url = "https://prod.truv.com/v1/orders/{id}/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"refresh_approved": True,
"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",
"funding_date": "2024-08-24"
},
"notes": "<string>",
"notification_settings": {
"suppress_user_notifications": False,
"first_notification_delay_hours": 0
}
}
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Access-Client-Id': '<api-key>',
'X-Access-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
ssn: '<string>',
refresh_approved: true,
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',
funding_date: '2024-08-24'
},
notes: '<string>',
notification_settings: {suppress_user_notifications: false, first_notification_delay_hours: 0}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'ssn' => '<string>',
'refresh_approved' => true,
'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',
'funding_date' => '2024-08-24'
],
'notes' => '<string>',
'notification_settings' => [
'suppress_user_notifications' => false,
'first_notification_delay_hours' => 0
]
]),
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/orders/{id}/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://prod.truv.com/v1/orders/{id}/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}")
.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::Patch.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"detail": "Not Found."
}Orders
Update an order
The endpoint updates the order. Update only available if all employers in one of statuses: pending, sent.
PATCH
/
v1
/
orders
/
{id}
/
Update an order
curl --request PATCH \
--url https://prod.truv.com/v1/orders/{id}/ \
--header 'Content-Type: application/json' \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"refresh_approved": true,
"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",
"funding_date": "2024-08-24"
},
"notes": "<string>",
"notification_settings": {
"suppress_user_notifications": false,
"first_notification_delay_hours": 0
}
}
'import requests
url = "https://prod.truv.com/v1/orders/{id}/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"ssn": "<string>",
"refresh_approved": True,
"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",
"funding_date": "2024-08-24"
},
"notes": "<string>",
"notification_settings": {
"suppress_user_notifications": False,
"first_notification_delay_hours": 0
}
}
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Access-Client-Id': '<api-key>',
'X-Access-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
ssn: '<string>',
refresh_approved: true,
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',
funding_date: '2024-08-24'
},
notes: '<string>',
notification_settings: {suppress_user_notifications: false, first_notification_delay_hours: 0}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'last_name' => '<string>',
'ssn' => '<string>',
'refresh_approved' => true,
'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',
'funding_date' => '2024-08-24'
],
'notes' => '<string>',
'notification_settings' => [
'suppress_user_notifications' => false,
'first_notification_delay_hours' => 0
]
]),
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/orders/{id}/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://prod.truv.com/v1/orders/{id}/")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}")
.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::Patch.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"ssn\": \"<string>\",\n \"refresh_approved\": true,\n \"loan\": {\n \"loan_number\": \"MUUT220700012\",\n \"application_number\": \"APP-2207-0001\",\n \"originator_name\": \"John Doe\",\n \"originator_email\": \"john@example.com\",\n \"loan_processor_name\": \"John Doe\",\n \"loan_processor_email\": \"john@doe.com\",\n \"external_id\": \"c505e0f1b4134fdc853fc87e7d2cc4a5\",\n \"funding_date\": \"2024-08-24\"\n },\n \"notes\": \"<string>\",\n \"notification_settings\": {\n \"suppress_user_notifications\": false,\n \"first_notification_delay_hours\": 0\n }\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"detail": "Not Found."
}Authorizations
Body
application/json
Response
Empty body
Was this page helpful?