Get one qualification check result

curl https://api.truework-sandbox.com/qualification-checks/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTQ \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <token>"

{
  "created": "2024-12-05T18:50:20Z",
  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC28",
  "kind": "applicant",
  "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",
    "name": "Conventional 2024",
    "income_multiple": "1.50"
  },
  "result": {
    "outcome": "qualified",
    "report_results": [
      {
        "report_id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC29",
        "monthly_gross_income": "2340.00",
        "satisfied_document_income_requirements": [
          {
            "file_type": "paystub",
            "end_date": "2023-01-31",
            "start_date": "2023-01-01"
          }
        ]
      }
    ],
    "monthly_gross_income": "4600.00",
    "monthly_gross_income_fidelity": "estimate",
    "rent_to_income_ratio": "0.85"
  },
  "metadata": {
    "key": "value"
  }
}

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.

Retrieves a qualification check result by id. <Warning> This endpoint is in beta and is subject to change. Please contact [implementations@truework.com](mailto:implementations@truework.com) for more information before integrating. </Warning>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

qualification_check_result_idstringRequired

Qualification Check Result ID

Response

createddatetime

idstring

kindenum

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

Allowed values:

property_detailsobject

Details from the originally supplied property, including the rent target

qualification_check_setobject

resultobject

metadatamap from strings to optional strings

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

Errors

400

Get One Qualification Check Request Bad Request Error

401

Get One Qualification Check Request Unauthorized Error

403

Get One Qualification Check Request Forbidden Error

404

Get One Qualification Check Request Not Found Error

406

Get One Qualification Check Request Not Acceptable Error

429

Get One Qualification Check Request Too Many Requests Error

451

Get One Qualification Check Request Unavailable for Legal Reasons Error

500

Get One Qualification Check Request Internal Server Error

501

Get One Qualification Check Request Not Implemented Error

Authentication

Path parameters

Headers

Response

Errors