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_qualificationChecks API

The subpackage_qualificationChecks API from Truework — 3 operation(s) for subpackage_qualificationchecks.

Truework subpackage_qualificationChecks 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.

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

This API exposes 3 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-30-beta.

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

3 operations 3 paths 28 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Truework subpackage_qualificationChecks 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 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_qualificationChecks 3
POST
/qualification-checks
Create a qualification check request
create-new-qualification-check 2 params body → 201400401403406429451500
GET
/qualification-checks/{qualification_check_result_id}
Get one qualification check result
get-one-qualification-check 3 params → 200400401403404406429451
GET
/qualification-check-sets
Get all qualification check sets
get-all-qualification-check-sets 4 params → 200400401403406429451500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are QualificationCheckCreatePostRequestV20231030 (7 properties), QualificationCheckResponseResourceV20231030 (7 properties), QualificationCheckSetResourceV20231030 (6 properties), _QualificationCheckResult (5 properties). Each schema is shown below with its type and property counts.

PropertyDetailsInputRent
The target rent amount for qualification, expressed in USD
Error406
object
1 property 1 required
Error400
object
1 property 1 required
QualificationChecksPostParametersAccept
string
QualificationCheckResponseResourceV20231030
object
7 properties 7 required
_PropertyDetails-Input
object
1 property 1 required
_QualificationCheckReportResult
object
4 properties 4 required
QualificationCheckSetListResourceV20231030
object
4 properties 4 required
QualificationCheckSetResourceV20231030
object
6 properties 6 required
_QualificationCheckSet
object
5 properties 5 required
Error451
object
1 property 1 required
QualificationCheckOutcome
string
The outcome of evaluating a specified set of qualification checks against specified report data
Error
object
1 property 1 required
_PropertyDetails-Output
object
1 property 1 required
QualificationChecksQualificationCheckResultIdGetParametersAccept
string
Error500
object
1 property 1 required
_SatisfiedDocumentIncomeRequirement
object
3 properties 3 required
Error404
object
1 property 1 required
Error401
object
1 property 1 required
QualificationCheckCreatePostRequestV20231030
object
7 properties 2 required
QualificationCheckIncomeFidelity
string
Whether or not the monthly gross income data was estimated using source data or provided directly from the source
QualificationCheckSetsGetParametersAccept
string
_QualificationCheckResult
object
5 properties 5 required
Error429
object
1 property 1 required
Error403
object
1 property 1 required
_InvalidRequestError
object
1 property 1 required
Error501
object
1 property 1 required
QualificationCheckKind
string
The kind of qualification check being requested, either for the applicant or guarantor.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Truework publishes across the network.

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

This is an independent, third-party profile of Truework subpackage_qualificationChecks 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.