HomeGuidesAPI ReferenceChangelog
API Reference
Get API Keys
Start typing to search…

Create an order

post
https://prod.truv.com/v1/orders/

The endpoint creates an order

Body Params

An Order for a user to link an account

products
array of strings
required

Types of products selected for the order

products*
string
required

First name

string
required

Last name

string

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

string

Subject's email

string

Subject's phone number

string

External ID for the order.

string | null

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

employers
array of objects

List of employers

employers
financial_institutions
array of objects
length ≤ 5

List of financial institutions

financial_institutions
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

string

ID of the template

string

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

cc_emails
array of strings
length ≤ 15

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

cc_emails
string | null

Free text field for notes associated with the order

string
enum

Type of the platform (internal, accio, etc.)

notification_settings
object

Configuration for order notifications

string
enum

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

Responses

Updated 8 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago