Skip to content
tlyfePro Partner API

GetPrequalificationStatus

GET
/v2.0/pre-qualification/current-status
curl --request GET \
  --url https://wl.api.cluster.openbrix.co.uk/v2.0/pre-qualification/current-status

Responses

Section titled “ Responses ”

200

Section titled “200”

Ok

Media typeapplication/json
object
data
required
object
preQualStatus
required
object
id_verification
object
payment_required
required
boolean
yoti_reason
required
string
idverification
required
number format: double
idverification_started_at
required
string format: date-time
right_to_rent
object
right_to_rent
required
string
right_to_rent_dob
required
string
right_to_rent_approved
required
boolean
right_to_rent_requested
required
boolean
affordability
object
salary
required
number format: double
nullable
affordability_amount
required
number format: double
nullable
fcc_pre_reference
tenant_info
fcc_guarantors
required
object
guarantor_payment_required
required
boolean
guarantors
required
Array<object>
object
application_id
required
string
report_content
required
string
nullable
last_fcc_update_at
required
string format: date-time
nullable
completed_date
required
string format: date-time
nullable
first_name
required
string
last_name
required
string
title
required
string
status
required
string
email
required
string
middle_name
required
string
tenant_prequalification_id
required
number format: double
fccdocs
required
status
required
boolean
Examplegenerated
{
  "data": {
    "preQualStatus": {
      "id_verification": {
        "payment_required": true,
        "yoti_reason": "example",
        "idverification": 1,
        "idverification_started_at": "2026-04-15T12:00:00Z"
      },
      "right_to_rent": {
        "right_to_rent": "example",
        "right_to_rent_dob": "example",
        "right_to_rent_approved": true,
        "right_to_rent_requested": true
      },
      "affordability": {
        "salary": 1,
        "affordability_amount": 1
      },
      "fcc_pre_reference": "example",
      "tenant_info": "example",
      "fcc_guarantors": {
        "guarantor_payment_required": true,
        "guarantors": [
          {
            "application_id": "example",
            "report_content": "example",
            "last_fcc_update_at": "2026-04-15T12:00:00Z",
            "completed_date": "2026-04-15T12:00:00Z",
            "first_name": "example",
            "last_name": "example",
            "title": "example",
            "status": "example",
            "email": "example",
            "middle_name": "example",
            "tenant_prequalification_id": 1
          }
        ]
      },
      "fccdocs": "example"
    }
  },
  "status": true
}