Get one qualification check result

{
  "created": "2024-12-05T18:50:20.291247Z",
  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC28",
  "kind": "applicant",
  "metadata": {},
  "property_details": {
    "rent": "2000.00"
  },
  "qualification_check_set": {
    "applicant_rent_to_income_ratio": "0.85",
    "guarantor_rent_to_income_ratio": "0.85",
    "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC27",
    "income_multiple": "1.50",
    "name": "Conventional 2024"
  },
  "result": {
    "monthly_gross_income": "4600.00",
    "monthly_gross_income_fidelity": "estimate",
    "outcome": "qualified",
    "rent_to_income_ratio": "0.85",
    "report_results": [
      {
        "monthly_gross_income": "2340.00",
        "monthly_gross_income_fidelity": "estimate",
        "report_id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC29",
        "satisfied_document_income_requirements": [
          {
            "end_date": "2023-01-31",
            "file_type": "paystub",
            "start_date": "2023-01-01"
          }
        ]
      }
    ]
  }
}

Retrieves a qualification check result by id.

This endpoint is in beta and is subject to change. Please contact implementations@truework.com for more information before integrating.

Authentication

AuthorizationBearer

Bearer tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
For the "try it now" token field, input only the token itself, omitting Bearer .

Path parameters

qualification_check_result_idstringRequired

Qualification Check Result ID

Response headers

DatestringOptional

For JSON requests, the date at which the request was signed

X-Truework-SignaturestringOptional

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

createddatetime

idstring

kindenum

The kind of qualification check that was performed, either for the applicant or guarantor

Allowed values:

metadatamap from strings to strings or null

A single level key-value JSON object that can be used to store custom data on the qualification check; keys and values must be strings

property_detailsobject

Details from the originally supplied property, including the rent target

qualification_check_setobject

resultobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

429

Too Many Requests Error

451

Unavailable for Legal Reasons Error

500

Internal Server Error

501

Not Implemented Error