The identity and technical contract details declared by the specification.
OrdersOrderIdEventsGetParametersAccept
string
EmployeeStatusOutputWrapperV20231030CanonicalValue
string
There are five employment statuses available on the status field in Employee: | VALUE | DESCRIPTION | VERSION INTRODUCED | OLDER VERSION VALUE | | ------------…
DetectionOutcomeWrapperCanonicalValue
string
The outcome of the detection rule. | VALUE | DESCRIPTION | | ----- | ----------- | | passed | The detection rule passed. | | failed | The detection rule failed…
OrderTargetEmployerVerificationRequestV20231030
object
12 properties
4 required
DisputeV20231030
object
4 properties
4 required
EmployeeStatusDetailOutputWrapperV20231030
object
2 properties
2 required
FinancialInstitutionIncomeStreamPeriodV20231030
object
6 properties
6 required
EmployerSearchConfigV20231030-Output
object
1 property
1 required
PositionV20231030
object
4 properties
4 required
UseCaseOutputWrapperV20231030
object
2 properties
2 required
Error
object
1 property
1 required
OrdersReverificationPostParametersAccept
string
Error500
object
1 property
1 required
CurrencyVMinimumVersion
string
ReverificationModeResourceV20231030
object
2 properties
2 required
EligibilityV20231030
object
4 properties
4 required
EmployeeStatusDetailOutputWrapperV20231030CanonicalValue
string
The statusdetail provides more granular information for some status values: | VALUE | DESCRIPTION | Status | | ------------------ | ---------------------------…
ActionTypeWrapper
object
2 properties
2 required
AddressV20220801-Input
object
6 properties
OrdersReverificationPostParametersRequestSync
string
TurnaroundTimeV20231030
object
3 properties
3 required
DetectionTypeWrapperCanonicalValue
string
The type of detection that was found on the document. | VALUE | DESCRIPTION | | ----- | ----------- | | ssn-mismatch | The SSN on the document does not match t…
VerificationRequestV20231030
object
3 properties
3 required
EligibilityProviderOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
OrderEmployerSearchVerificationRequestV20231030
object
12 properties
4 required
CancellationReasonOutputWrapperV20231030
object
2 properties
2 required
FinancialInstitutionAccountV20231030
object
8 properties
8 required
EmploymentTypeOutputWrapperV20231030CanonicalValue
string
| VALUE | DESCRIPTION | VERSION INTRODUCED | OLDER VERSION VALUE | | ----------------- | -------------------------------- | ------------------ | --------------…
OrderAnnotationsV20231030
object
2 properties
2 required
OrderCancelPutRequestV20231030
object
2 properties
1 required
VerificationMethodV20231030
string
FinancialInstitutionAccountSnapshotV20231030
object
9 properties
9 required
Error501
object
1 property
1 required
OrderTrueworkDirectPostRequestV20231030
object
4 properties
1 required
DocumentOutputResourceV20220801
object
1 property
1 required
EmployerSearchConfigV20231030-Input
object
1 property
SalaryV20231030
object
4 properties
4 required
ReverificationTargetOutputV20231030
object
3 properties
3 required
CompletedByMethodOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
OrderVerificationResponseResourceV20231030
object
19 properties
19 required
TargetEmployerVerificationConfigV20231030-Output
object
1 property
1 required
CompanyByNameInputV20220801
object
4 properties
1 required
EligibilityTypeOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
SelfEmploymentOutputV20231030
object
1 property
1 required
_SalaryAnnotation
object
1 property
1 required
SelfEmploymentInputV20231030
object
1 property
OrderEmployerSearchVerificationTargetOutputV20231030
object
5 properties
5 required
ReducedCovidVMinimumVersion
string
OrderListResponseResourceV20231030
object
4 properties
4 required
EventResourceV20231030
object
6 properties
6 required
CompanyOutputV20220801
object
4 properties
4 required
OrderVerificationReportResourceV20231030
object
17 properties
17 required
VerificationTypeVMinimumVersion
string
ExternalStateOutputWrapperV20231030CanonicalValue
string
The state helps convey where the verification request is in the Truework process. It will be returned in the JSON objects returned from this endpoint. The init…
TargetEmployerVerificationConfigV20231030-Input
object
1 property
AuthorizationFormV20220801
object
Supporting documentation for the request in PDF, JPEG, or PNG format
2 properties
2 required
OrdersTargetEmployerPostParametersAccept
string
EmployerSearchModeResourceV20231030
object
11 properties
11 required
EmployerFilterV20231030
string
Error429
object
1 property
1 required
TrueworkDirectModeResourceV20231030
object
1 property
1 required
ApplicantDocumentMetadataV20220801
object
3 properties
3 required
EligibilityTypeOutputWrapperV20231030
object
2 properties
2 required
ReportIncomeAnalyticsV20231030
object
2 properties
2 required
PermissiblePurposeOutputWrapperV20231030
object
2 properties
2 required
_AnnualizedIncome
object
5 properties
5 required
PayUnitOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
Error406
object
1 property
1 required
UseCaseInputVMinimumVersion
string
The verification request use case describes the type of product the verification request is originating from. If omitted, the verifier type in account settings…
_EmployeeAnnotation
object
4 properties
4 required
CompanyOutputVMinimumVersion
object
7 properties
7 required
OrderResponseResourceV20231030
object
9 properties
9 required
OrdersGetParametersAccept
string
_GovernmentId
object
2 properties
2 required
ResellerOriginatingPartyInputV20220801
object
3 properties
3 required
PayUnitOutputWrapperV20231030
object
2 properties
2 required
DocumentDetection
object
3 properties
3 required
OrdersOrderIdGetParametersAccept
string
GovernmentIdTypeOutputWrapperV20231030
object
2 properties
2 required
DetectionTypeWrapper
object
2 properties
2 required
GrossIncomeCalculationResultV20231030
object
3 properties
3 required
_EmployerAnnotation
object
3 properties
3 required
EmployeeV20231030
object
14 properties
14 required
EventListResource
object
4 properties
4 required
OrderEmployerSearchVerificationTargetInputV20231030
object
6 properties
4 required
CancellationReasonOutputWrapperV20231030CanonicalValue
string
| VALUE | DESCRIPTION | | -------------------- | ---------------------------------------------------------------------------------------------------- | | immed…
PayRateV20231030
object
2 properties
2 required
EmployerV20231030
object
3 properties
3 required
SubmissionTargetOutputVMinimumVersion
object
7 properties
7 required
UseCaseOutputWrapperV20231030CanonicalValue
string
The verification request use case describes the type of product the verification request is originating from. If omitted, the verifier type in account settings…
ActionTypeWrapperCanonicalValue
string
Action Truework should take for applicant's employment at this company. | VALUE | DESCRIPTION | | ----- | ----------- | | verify | Truework should attempt to v…
ResellerOriginatingPartyOutputV20231030
object
3 properties
3 required
OrdersTrueworkDirectPostParametersAccept
string
MoneyAmountVMinimumVersion
object
2 properties
2 required
PayFrequencyOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
EarningsV20231030
object
7 properties
7 required
DetectionOutcomeWrapper
object
2 properties
2 required
CompanyInputV20231030
object
2 properties
1 required
FinancialInstitutionIncomeStreamV20231030
object
13 properties
13 required
PermissiblePurposeOutputWrapperV20231030CanonicalValue
string
A valid purpose is required for Truework to process the verification request. Throughout the API, this is signified by the permissiblepurpose field. | VALUE |…
OrderReverificationRequestV20231030
object
1 property
1 required
TrueworkDirectTargetInputV20231030
object
14 properties
8 required
_OrderAnnotation
object
2 properties
2 required
TrueworkDirectTargetOutputV20231030
object
15 properties
15 required
OrderVerificationCancelResponseResourceV20231030
object
8 properties
8 required
EligibilityProviderOutputWrapperV20231030
object
2 properties
2 required
CompletedByMethodOutputWrapperV20231030
object
2 properties
2 required
OrderTargetEmployerVerificationTargetOutputV20231030
object
6 properties
6 required
Error400
object
1 property
1 required
ActionType
string
Action Truework should take for applicant's employment at this company. | VALUE | DESCRIPTION | | ----- | ----------- | | verify | Truework should attempt to v…
CompanyOutputV20231030
object
2 properties
2 required
EmployeeStatusOutputWrapperV20231030
object
2 properties
2 required
RespondentV20231030
object
3 properties
3 required
OrderTargetEmployerVerificationTargetInputV20231030
object
7 properties
4 required
_IncomeVolatility
object
1 property
1 required
PaystubV20231030
object
13 properties
13 required
PermissiblePurposeInputV20220801
string
A valid purpose is required for Truework to process the verification request. Throughout the API, this is signified by the permissiblepurpose field. | VALUE |…
OrderCancelResponseResourceV20231030
object
3 properties
3 required
Error451
object
1 property
1 required
GovernmentIdTypeOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
CancellationReasonInputVMinimumVersion
string
| VALUE | DESCRIPTION | | -------------------- | ---------------------------------------------------------------------------------------------------- | | immed…
OrdersOrderIdCancelPutParametersAccept
string
ExternalStateOutputWrapperV20231030
object
2 properties
2 required
Error404
object
1 property
1 required
Error401
object
1 property
1 required
OrdersEmployerSearchPostParametersAccept
string
PayFrequencyOutputWrapperV20231030
object
2 properties
2 required
VerificationTypeV20231030
string
TargetEmployerModeResourceV20231030
object
11 properties
11 required
Error403
object
1 property
1 required
EmploymentTypeOutputWrapperV20231030
object
2 properties
2 required
_PositionAnnotation
object
3 properties
3 required
AddressV20220801-Output
object
6 properties
6 required
_InvalidRequestError
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Truework publishes across the network.
