How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Truework subpackage_reports API

The subpackage_reports API from Truework — 1 operation(s) for subpackage_reports.

Truework subpackage_reports API is one of 6 APIs that Truework publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-30.

Requests are made against 2 base URLs: https://api.truework-sandbox.com, https://api.truework.com.

1 operations 1 paths 68 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-30
Base URL
https://api.truework.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Truework subpackage_reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer).

  • Bearer — Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750section-2.1) spec. Production API keys (secret keys) are prefixed with twsk…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

subpackage_reports 1
GET
/reports/{verification_report_id}
Get one report
get-report-details 6 params → 200400401403404406429451

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are OrderVerificationReportResourceV20231030 (17 properties), EmployeeV20231030 (14 properties), FinancialInstitutionIncomeStreamV20231030 (13 properties), PaystubV20231030 (13 properties). Each schema is shown below with its type and property counts.

EligibilityProviderOutputWrapperV20231030
object
2 properties 2 required
SalaryV20231030
object
4 properties 4 required
_AnnualizedIncome
object
5 properties 5 required
CompletedByMethodOutputWrapperV20231030
object
2 properties 2 required
EmployeeStatusOutputWrapperV20231030CanonicalValue
string
There are five employment statuses available on the status field in Employee: | VALUE | DESCRIPTION | VERSION INTRODUCED | OLDER VERSION VALUE | | ------------…
CompletedByMethodOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
DetectionOutcomeWrapperCanonicalValue
string
The outcome of the detection rule. | VALUE | DESCRIPTION | | ----- | ----------- | | passed | The detection rule passed. | | failed | The detection rule failed…
PayUnitOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
Error406
object
1 property 1 required
Error400
object
1 property 1 required
DisputeV20231030
object
4 properties 4 required
_EmployeeAnnotation
object
4 properties 4 required
EligibilityTypeOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
EmployeeStatusDetailOutputWrapperV20231030
object
2 properties 2 required
FinancialInstitutionIncomeStreamPeriodV20231030
object
6 properties 6 required
_GovernmentId
object
2 properties 2 required
_SalaryAnnotation
object
1 property 1 required
ReducedCovidVMinimumVersion
string
PayUnitOutputWrapperV20231030
object
2 properties 2 required
DocumentDetection
object
3 properties 3 required
GovernmentIdTypeOutputWrapperV20231030
object
2 properties 2 required
DetectionTypeWrapper
object
2 properties 2 required
GrossIncomeCalculationResultV20231030
object
3 properties 3 required
EmployeeStatusOutputWrapperV20231030
object
2 properties 2 required
_EmployerAnnotation
object
3 properties 3 required
ReportIncomeAnalyticsV20231030
object
2 properties 2 required
EmployeeV20231030
object
14 properties 14 required
RespondentV20231030
object
3 properties 3 required
_IncomeVolatility
object
1 property 1 required
PaystubV20231030
object
13 properties 13 required
PositionV20231030
object
4 properties 4 required
PayRateV20231030
object
2 properties 2 required
Error451
object
1 property 1 required
OrderVerificationReportResourceV20231030
object
17 properties 17 required
_InvalidRequestError
object
1 property 1 required
GovernmentIdTypeOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
Error
object
1 property 1 required
EmployerV20231030
object
3 properties 3 required
Error500
object
1 property 1 required
CurrencyVMinimumVersion
string
EligibilityV20231030
object
4 properties 4 required
Error404
object
1 property 1 required
Error401
object
1 property 1 required
EmployeeStatusDetailOutputWrapperV20231030CanonicalValue
string
The statusdetail provides more granular information for some status values: | VALUE | DESCRIPTION | Status | | ------------------ | ---------------------------…
MoneyAmountVMinimumVersion
object
2 properties 2 required
VerificationRequestV20231030
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…
PayFrequencyOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
EligibilityProviderOutputWrapperV20231030CanonicalValue
string
A limited enum representation of the value, which will not be extended without a version bump.
PayFrequencyOutputWrapperV20231030
object
2 properties 2 required
EarningsV20231030
object
7 properties 7 required
DetectionOutcomeWrapper
object
2 properties 2 required
VerificationTypeV20231030
string
OrderAnnotationsV20231030
object
2 properties 2 required
FinancialInstitutionAccountV20231030
object
8 properties 8 required
FinancialInstitutionIncomeStreamV20231030
object
13 properties 13 required
EmploymentTypeOutputWrapperV20231030CanonicalValue
string
| VALUE | DESCRIPTION | VERSION INTRODUCED | OLDER VERSION VALUE | | ----------------- | -------------------------------- | ------------------ | --------------…
Error403
object
1 property 1 required
Error429
object
1 property 1 required
ReportsVerificationReportIdGetParametersAccept
string
EmploymentTypeOutputWrapperV20231030
object
2 properties 2 required
_PositionAnnotation
object
3 properties 3 required
FinancialInstitutionAccountSnapshotV20231030
object
9 properties 9 required
_OrderAnnotation
object
2 properties 2 required
ApplicantDocumentMetadataV20220801
object
3 properties 3 required
AddressV20220801-Output
object
6 properties 6 required
EligibilityTypeOutputWrapperV20231030
object
2 properties 2 required
Error501
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

truework-subpackage-reports-api-openapi.yml Raw ↑

Other APIs Truework publishes across the network.

Truework.js (Truework Direct)
Truework subpackage_orders API
Truework subpackage_qualificationChecks API
Truework subpackage_tenantProperties API
Truework Truework Webhooks API
Where this information came from

This is an independent, third-party profile of Truework subpackage_reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.