Skip to navigation

Create a Truework Direct order

POST requests create an order with a Truework Direct session token, used for instantiating the Truework.js widget.

Authentication

AuthorizationBearer

Bearer tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

  • For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
  • For the "try it now" token field, input only the token itself, omitting Bearer .

Headers

AcceptenumOptionalDefaults to application/json
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Allowed values:

Request

This endpoint expects an object.
targetslist of objectsRequired
assets_configobject or nullOptional
Configuration for adding an assets verification to the order. If provided, the created order will include both an income and employment verification and an assets verification. Contact your Truework representative to enable it for your account.
branch_idstring or nullOptional<=128 characters
The branch id associated with the verification request
loan_idstring or nullOptional
The loan id associated with the verification request
search_keystring or nullOptional

A non-unique key that can be used to search for Orders

tenant_property_idstring or nullOptional
The ID of the tenant property to be used for this verification request.

Response headers

DatestringOptional
For JSON requests, the date at which the request was signed
X-Truework-SignaturestringOptional

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

Order Created.
assetsobject or null

Response object specific to Assets requests or VOA add-ons.

branch_idstring or null
The branch id associated with the verification request
idstring1-128 characters
loan_idstring or null
The loan id associated with the verification request
reverificationobject or null
Response object specific to Reverification requests.
search_keystring or null

A non-unique key that can be used to search for Orders

self_employmentobject or null

Response object specific to Self Employment requests or self-employment add-ons.

target_employerobject or null
Response object specific to Target Employer requests.
truework_directobject or null
Response object specific to Truework Direct requests.
verification_requestslist of objects or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
451
Unavailable for Legal Reasons Error
500
Internal Server Error
501
Not Implemented Error