Get order batch job status

curl --request GET \
  --url https://prod.truv.com/v1/orders/batch/{id}/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'

import requests

url = "https://prod.truv.com/v1/orders/batch/{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/batch/{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/batch/{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/batch/{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))

}

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/orders/batch/{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": "9f2c1b7e4a3d4e8fa1b2c3d4e5f60718",
  "status": "completed",
  "order_count": 3,
  "created_count": 2,
  "failed_count": 1,
  "results": [
    {
      "index": 0,
      "status": "created",
      "order_id": "39aa1486ccca4bc19cda071ffc1ba392",
      "order_number": "CASE-001",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "share_url": "https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "errors": {
        "last_name": [
          "This field is required."
        ]
      }
    }
  ],
  "errors": [
    {
      "detail": [
        "The batch could not be processed."
      ]
    }
  ],
  "created_at": "2026-08-10T09:14:22.881Z",
  "updated_at": "2026-08-10T09:15:04.203Z"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

{
  "detail": "Not Found."
}

GET

orders

batch

{id}

Get order batch job status

curl --request GET \
  --url https://prod.truv.com/v1/orders/batch/{id}/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'

import requests

url = "https://prod.truv.com/v1/orders/batch/{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/batch/{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/batch/{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/batch/{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))

}

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/orders/batch/{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": "9f2c1b7e4a3d4e8fa1b2c3d4e5f60718",
  "status": "completed",
  "order_count": 3,
  "created_count": 2,
  "failed_count": 1,
  "results": [
    {
      "index": 0,
      "status": "created",
      "order_id": "39aa1486ccca4bc19cda071ffc1ba392",
      "order_number": "CASE-001",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "share_url": "https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "errors": {
        "last_name": [
          "This field is required."
        ]
      }
    }
  ],
  "errors": [
    {
      "detail": [
        "The batch could not be processed."
      ]
    }
  ],
  "created_at": "2026-08-10T09:14:22.881Z",
  "updated_at": "2026-08-10T09:15:04.203Z"
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

{
  "detail": "Not Found."
}

Authorizations

X-Access-Client-Id

string

header

required

Client ID

X-Access-Secret

string

header

required

Client Access Key

Path Parameters

string

required

Batch job ID received from the POST request

Response

string

Batch job ID. Use it to poll the job status.

Example:

"9f2c1b7e4a3d4e8fa1b2c3d4e5f60718"

status

enum<string>

pending while orders are still being created, then completed once every order has an outcome, or failed if the whole job could not run.

Available options:

pending,

completed,

failed

Example:

"completed"

order_count

integer

Number of orders submitted in the request.

Example:

3

created_count

integer

Number of orders that are usable, counting both created and existing.

Example:

2

failed_count

integer

Number of orders that could not be created.

Example:

1

results

object[]

Outcome of each submitted order, matched to its position in the request.

Show child attributes

errors

object[] | null

Why the job as a whole could not run. Set only when status is failed, and null otherwise — errors for individual orders are in results[].errors instead.

Show child attributes

Example:

[
  {
    "detail": ["The batch could not be processed."]
  }
]

created_at

string<date-time>

Time the batch was accepted.

Example:

"2026-08-10T09:14:22.881Z"

updated_at

string<date-time>

Time the batch was last updated.

Example:

"2026-08-10T09:15:04.203Z"

⌘I

API Reference

Platform

Income & Employment

Financial Accounts

Document Processing

Direct Deposit Switch

Insurance Verification

Get order batch job status

Authorizations

Path Parameters

Response