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>'

{
  "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": "6500.00",
          "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": "12-345678"
          },
          "profile": {
            "id": "48427a36d43c4d5aa6324bc06c692456",
            "first_name": "John",
            "last_name": "Doe",
            "full_name": "John Doe",
            "email": "john.doe@example.com",
            "date_of_birth": "1992-03-03"
          }
        }
      ]
    }
  ],
  "insurance": {
    "id": "ad9f14440d624ec3b0f66e81e44518c7",
    "product_type": "insurance",
    "status": "pending",
    "created_at": "2021-04-21T22:12:59.346109Z",
    "provider": {
      "id": "truv_api",
      "name": "Sandbox Provider"
    },
    "is_suspicious": true,
    "provider_id": "geico"
  },
  "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"
      },
      "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"
                }
              ]
            }
          ],
          "avg_deposit_amount": "5000.00"
        }
      ]
    }
  ],
  "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"
}

GET

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>'

{
  "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": "6500.00",
          "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": "12-345678"
          },
          "profile": {
            "id": "48427a36d43c4d5aa6324bc06c692456",
            "first_name": "John",
            "last_name": "Doe",
            "full_name": "John Doe",
            "email": "john.doe@example.com",
            "date_of_birth": "1992-03-03"
          }
        }
      ]
    }
  ],
  "insurance": {
    "id": "ad9f14440d624ec3b0f66e81e44518c7",
    "product_type": "insurance",
    "status": "pending",
    "created_at": "2021-04-21T22:12:59.346109Z",
    "provider": {
      "id": "truv_api",
      "name": "Sandbox Provider"
    },
    "is_suspicious": true,
    "provider_id": "geico"
  },
  "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"
      },
      "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"
                }
              ]
            }
          ],
          "avg_deposit_amount": "5000.00"
        }
      ]
    }
  ],
  "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"
}

Authorizations

X-Access-Client-Id

string

header

required

Client ID

X-Access-Secret

string

header

required

Client Access Key

Path Parameters

string

required

Order ID received from the POST request

Query Parameters

certification

enum<string>

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

string

required

Unique ID

Example:

"39aa1486ccca4bc19cda071ffc1ba392"

products

enum<string>[]

required

Types of products selected for the order

Available options:

income,

employment,

deposit_switch,

pll,

insurance,

transactions,

assets

Example:

["income"]

source

enum<string>

required

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

string

required

Client name displayed on the order page

Example:

"Unnamed Verifications Inc."

first_name

string

required

First name

Example:

"John"

last_name

string

required

Last name

Example:

"Doe"

user_id

string

required

Unique Truv ID of the user.

Example:

"99dd17074ac94aa9ace2621d657c7610"

Landing page URL to share

Example:

"https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392"

created_at

string<date-time>

required

Date and time when order was created

Example:

"2021-04-21T21:45:14.418542Z"

expired_at

string<date-time>

required

Date and time when order would expire

Example:

"2021-04-24T21:45:14.418542Z"

is_expired

boolean

required

If order is already expired

employers

object[]

required

List of employers

Show child attributes

financial_accounts

object[] | null

required

List of financial accounts

Show child attributes

order_number

string | null

External ID

Example:

"1534332"

custom_field

string | null

User provided custom field. Must be enabled in the customization section.

bridge_token

string

UUID value of bridge token

Example:

"e4100fccdae94691b4414c7306220c06"

updated_at

string<date-time>

Date and time when order was updated

Example:

"2021-04-21T21:45:14.418542Z"

canceled_at

string<date-time> | null

Date and time when order was canceled

Example:

"2021-04-22T21:45:14.418542Z"

completed_at

string<date-time> | null

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"

initial_order

string | null

ID of an origin order if the order was created by the order data refresh operation

Example:

"f5dc0239e2094dbc90ab2edc1918a9df"

refresh_order

string | null

ID of the last refresh order created by the order data refresh operation for the order

Example:

"9b96606355b94e8abff8ed8d75aa2027"

insurance

object

Insurance verification meta data

Show child attributes

manager

object

Order manager info associated with an order.

Show child attributes

loan

object

Loan Information

Show child attributes

template_id

string | null

ID of the template

Example:

"9b96606355b94e8abff8ed8d75aa2027"

cc_emails

string<email>[]

A list of email addresses that will receive carbon copies (CC) of order status updates.

Maximum array length: 15

Shortened verification URL to share

Example:

"https://truv.com/s/BIlEyh1A"

voie_report_id

string | null

GSE accepted income and employment verification report ID

Example:

"b19c454a98594b4084b71e3b62873d29"

voa_report_id

string | null

Verification of Assets report ID

Example:

"b19c454a98594b4084b71e3b62873d29"

income_insights_report_id

string | null

Income Insights report ID

Example:

"b19c454a98594b4084b71e3b62873d29"

aim_check_report_id

string | null

AIM check report ID

Example:

"FM-1234-39aa1486ccca4bc19cda071ffc1ba392"

notes

string | null

Free text field for notes associated with the order

Required string length: 1 - 2000

Example:

"To be processed by John Doe"

Get list of orders by SSN Update an order

⌘I