Skip to main content
POST
Create an order

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Body

application/json

An Order for a user to link an account

products
enum<string>[]
required

Types of products selected for the order

Available options:
income,
employment,
deposit_switch,
pll,
insurance,
transactions,
assets
Example:
first_name
string
required

First name

Example:

"John"

last_name
string
required

Last name

Example:

"Doe"

ssn
string

User's SSN. Should be 4 or 9 digits length.

Example:

"222233333"

email
string<email>

Subject's email

phone
string

Subject's phone number

Example:

"4155554193"

order_number
string

External ID for the order.

Example:

"1534332"

external_user_id
string | null

External user identifier. If not provided, order_number will be used for backwards compatibility.

Maximum string length: 512
Example:

"user_12345"

employers
object[]

List of employers

financial_institutions
object[]

List of financial institutions

Maximum array length: 5
insurance
object

Insurance verification additional parameters

manager
object

Associate your order manager info with an order.

loan
object | null

Loan Information

reports
object

Reports parameters

template_id
string

ID of the template

Example:

"9b96606355b94e8abff8ed8d75aa2027"

custom_field
string

Client provided custom field. Must be enabled in the dashboard customization section.

cc_emails
string<email>[]

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

Maximum array length: 15
notes
string | null

Free text field for notes associated with the order

Required string length: 1 - 2000
Example:

"To be processed by John Doe"

source
enum<string>

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"

notification_settings
object

Configuration for order notifications

locale
enum<string>

Locale parameter (ISO 639) for regional customization of the order

Available options:
en,
ar,
cmn,
es,
fa,
hy,
km,
zh,
hi,
hmn,
ja,
ko,
lo,
ium,
pa,
pt,
ru,
so,
tl,
th,
uk,
vi
Example:

"es"

Response

id
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:
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"

share_url
string | null
required

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

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

Insurance verification meta data

manager
object | null

Order manager info associated with an order.

financial_accounts
object[] | null

List of financial accounts

loan
object | null

Loan Information

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
short_share_url
string | null

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"