Public beta APIsQualification checks (beta)

Get one qualification check result

Beta

Retrieves a qualification check result by id.

<!— theme: warning —>

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

Path parameters

qualification_check_result_idstringRequired
Qualification Check Result ID

Headers

AuthorizationstringRequired

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

Accept"application/json"Required
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.

Response

OK
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 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

Errors