Skip to main content

Testing in the Sandbox

First Time Using the Sandbox?

To get up and running check out Making Your First API Request.

info

The base URL for the Truework Sandbox is https://api.truework-sandbox.com.

Test values in the Truework Sandbox are identified by their SSN. The SSN is split into 3 parts: the first three digits, the middle two digits, and the last four digits. They can be changed independently to create different combinations. Any verification created in the sandbox that does not use a supported test SSN will remain in a pending state indefinitely, and will never be completed.

info

The first three digits must always be 000 for test SSNs.

Terminal State and Webhook Values#

The permutation of webhooks generated by a Verification and its terminal state are designated by the middle two digits of a test SSN. The following values are supported:

Smart Outreach Requests#

These values are valid for Smart Outreach requests (those that include a target company name or ID).

VALUEWEBHOOKS GENERATEDTERMINAL STATE
00processing, completedcompleted
01processing, canceledcanceled
02completedcompleted
03processing, action-requiredaction-required

Instant Requests#

These values are valid for Instant requests (those that do not include a target company).

VALUEWEBHOOKS GENERATEDTERMINAL STATE
10completedcompleted
11canceledcanceled
caution

Using the wrong Terminal State value for the given request type may result in behavior that doesn't properly emulate production behavior. Only use Smart Outreach Request Terminal State values for requests that include a target company, and Instant Request Terminal State values for requests that do not include a target company.

Credential Sessions#

These values are valid for Credential Sessions and are used to determine if a verification request is created or not.

VALUEWEBHOOKS GENERATEDTERMINAL STATE
00successsuccess
01failedfailed

Report Values#

The report data returned for a verification is designated by the last four digits of a test SSN. The following values are supported:

info

Report data will only be created for Verifications that use a Terminal State and Webhook value with a terminal state of completed.

Verification of Employment#

Multiple Reports

Instant Requests (those that do not include a target company) may return multiple reports. To emulate this behavior, use the Engineering Manager example report (value 0007). The tables below describe both reports for this value. If this value is used in a non-instant request, only the latest report will be returned.

VALUETITLESTATUSTYPESTART DATEEND DATE
0000Software EngineerActiveFull Time2018-01-01
0001Program ManagerInactiveFull Time2014-05-012021-02-06
0002AccountantOn LeavePart Time2016-02-03
0003Product ManagerActiveFull Time2021-01-10
0004Customer Service RepresentativeActivePart Time2020-05-19
0005Account ExecutiveInactiveFull Time2018-03-012019-12-28
0006RecruiterInactiveFull Time2017-03-012020-03-10
0007
Latest
Engineering ManagerActiveFull Time2021-01-01
0007
Previous
Engineering ManagerInactiveFull Time2017-03-012020-12-01

Verification of Income#

info

Verification of income reports also include the data in the verification of employment table.

VALUEBASE PAYPAY FREQUENCYINCOME YEARS
0000$150,000Annually2021, 2020, 2019
0001$5,000Bi-weekly2021, 2020, 2019
0002$1,000Weekly2021, 2020, 2019
0003$120,000Annually2021
0004$15Hourly2021, 2020
0005$85,000Annually2019, 2018
0006$3,750Bi-weekly2020, 2019
0007
Latest
$200,000Annually2021
0007
Previous
$165,000Annually2020, 2019

Income Breakdown#

VALUE2021202020192018
0000base: $50,000
bonus: $0
commission: $0
overtime: $0
other: $0
base: $150,000
bonus: $50,000
commission: $0
overtime: $0
other: $0
base: $100,000
bonus: $25,000
commission: $0
overtime: $0
other: $0
0001base: $10,000
bonus: $0
commission: $0
overtime: $0
other: $5,000
base: $120,000
bonus: $15,000
commission: $0
overtime: $0
other: $10,000
base: $100,000
bonus: $10,000
commission: $0
overtime: $0
other: $5,000
0002base: $1,000
bonus: $0
commission: $0
overtime: $0
other: $0
base: $45,000
bonus: $0
commission: $0
overtime: $0
other: $0
base: $45,000
bonus: $0
commission: $0
overtime: $0
other: $0
0003base: $35,000
bonus: $15,000
commission: $0
overtime: $0
other: $0
0004base: $8,000
bonus: $0
commission: $0
overtime: $500
other: $0
base: $45,000
bonus: $2,000
commission: $0
overtime: $10,000
other: $0
0005base: $85,000
bonus: $10,000
commission: $60,000
overtime: $0
other: $0
base: $65,000
bonus: $10,000
commission: $80,000
overtime: $0
other: $0
0006base: $15,000
bonus: $0
commission: $60,000
overtime: $0
other: $0
base: $90,000
bonus: $20,000
commission: $0
overtime: $0
other: $0
0007
Latest
base: $100,000
bonus: $50,000
commission: $0
overtime: $0
other: $0
0007
Previous
base: $165,000
bonus: $20,000
commission: $0
overtime: $0
other: $0
base: $150,000
bonus: $0
commission: $0
overtime: $0
other: $0
Income Years

The leftmost column in this table will always be the current year, but the data in each column will remain constant from year to year. When the current year changes, the data returned for each year will therefore change as well (next year the returned data will span from 2022-2019).

Companies#

There is only one test company in the Truework Sandbox:

info

Any Verification which is created using exclusively a target company name and no id will result in a generated report with that company name.

info

If a target company id value is passed in the request, it must be an ID from the table below, or the request will fail. In the case that an id is provided, the provided name value will be ignored.

IDCOMPANY NAME
1Truework - DEMO