Skip to main content
POST
Add new employer to the existing order

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

id
string
required

Order ID received from the POST request

Body

application/json
start_date
string<date>

Job start date

Example:

"2019-08-24"

end_date
string<date>

Job end date

Example:

"2019-11-27"

company_name
string

Company name

Maximum string length: 128
Example:

"Facebook Demo"

company_address
object

Company address

company_domain
string

Company website domain

Maximum string length: 128
Example:

"facebook.com"

Company logo URL

Maximum string length: 512
Example:

"https://cdn.truv.com/company_logos/facebook.svg"

suborder_number
string

External ID

Maximum string length: 512
Example:

"133982343355"

company_mapping_id
string

Company mapping ID

Maximum string length: 64
Example:

"self_employed"

Response

id
string
required

Unique ID

Maximum string length: 32
Example:

"ad9f14440d624ec3b0f66e81e44518c7"

status
enum<string>
required

Order status

Available options:
pending,
sent,
completed,
error,
canceled,
expired,
no_data,
skipped
Example:

"pending"

created_at
string
required

Date and time when order was created

Example:

"2021-04-21T22:12:59.346109Z"

employments
object[] | null
required

List of employments

product_type
enum<string>

Type of the product.

Available options:
income,
employment,
deposit_switch,
pll
Example:

"income"

suborder_number
string | null

External ID

Maximum string length: 512
Example:

"133982343355"

bridge_token
string

UUID value of bridge token

Maximum string length: 32
Example:

"e4100fccdae94691b4414c7306220c06"

Link ID for the connected account

Maximum string length: 32
Example:

"e4100fccdae94691b4414c7306220c06"

access_token
string | null

Access token to perform data refresh

Maximum string length: 32
Example:

"e4100fccdae94691b4414c7306220c06"

pdf_report
string<uri> | null

Verification report in PDF format

Example:

"https://cdn.truv.com/report.pdf"

data_source
enum<string> | null

Source of data: payroll - payroll provider parsing, docs - user uploaded documents, tax - tax documents, financial_accounts - bank data.

Available options:
payroll,
docs,
tax,
financial_accounts,
null
Example:

"payroll"

provider
object | null

Payroll or insurance provider

is_suspicious
boolean

Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data

last_task_status
enum<string> | null
read-only

Status of the most recent task for the connection. Terminal statuses are done, error, login_error, account_locked, mfa_error, config_error, no_data, unavailable, unable_to_reset, and not_supported. The remaining values are in-progress statuses that appear while a verification is still running. Returns null when no task exists for the connection yet.

Available options:
done,
error,
login_error,
account_locked,
mfa_error,
config_error,
no_data,
unavailable,
unable_to_reset,
not_supported,
new,
login,
mfa,
parse,
full_parse,
switch_deposit,
session_expired,
null
Example:

"done"

start_date
string | null

Employment start date

Example:

"2019-08-24"

end_date
string | null

Employment start date

Example:

"2019-11-27"

company_name
string | null

Company name

Maximum string length: 128
Example:

"Facebook Demo"

company_address
object | null

Company address

company_domain
string | null

Company website domain

Maximum string length: 128
Example:

"facebook.com"

company_logo
string<uri> | null

Company logo URL

Maximum string length: 512
Example:

"https://cdn.truv.com/company_logos/facebook.svg"