Public beta APIsQualification checks (beta)

Create a qualification check request

Beta

Creates a new qualification check and returns a JSON object with the resulting evaluation.

<!— theme: warning —>

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

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.

Request

This endpoint expects an object.
property_detailsobjectRequired
qualification_check_set_idstringRequired
metadatamap from strings to optional stringsOptional

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

order_idstringOptional
order_idslist of stringsOptional
report_idslist of stringsOptional

Response

Qualification Check Evaluation Created.

createddatetime
idstring
property_detailsobject

Details from the originally supplied property, including the rent target

qualification_check_setobject
resultobject
metadatamap from strings to optional stringsOptional

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