Referencing Product

jwt
Getting Started API Specifications
Guarantor only referencing API Outcomes Conditional Pass and Conditions Met: Explained Emails Document Types Touchpoints overview Touchpoints vs. Milestones

Guarantor only referencing

Guarantor only referencing

With the Goodlord Referncing API we support guarantor only referencing.

When creating Guarantors using the Goodlord Referencing API we require that a guarantor is always associated with a tenant.

This makes the guarantor only referencing journey slightly unusual as it requires sending details about a tenant that we will not be referencing.

In order for us to know that this Tenant should not be rerferenced we require the Tenant's product to be set to a value of None (see full example Subject below).

In this use case, despite the reference being for the guarantor, we require you to create a tenant 'shell' that represents the tenant that the guarantor is responsible via the API before creating your guarantor. This Tenant 'shell' will only require you to provide the most basic details (required fields are detailed below). When you create the guarantor you wish to send to referencing you will then need to link the guarantor to the tenant using the relatedSubjects field.

The linking of a tenant to guarantor is the same process if you are referencing the guarantor and subject use case.

Goodlord will NOT perform a reference for this Tenant 'shell' and Goodlord will NOT send any emails to the tenant.

The guarantor will be able to follow the standard referencing journey.

Example 1 - Creating a tenant 'shell'

{
    "type": "applicant",
    "attachedSubjects": [],
    "context": {
        "firstName": "None",
        "lastName": "Product",
        "mobile": "07123456789",
        "email": "test-no-product@test.com",
        "product": "None" // Critical: this prevents Goodlord referencing this Tenant
    },
    "rentalDetails": {
        "priceShare": 100,
        "affordabilityRatio": 2.6
    }
}

Example 2 - Subject payload to create the guarantor we should reference.

{
    "type": "guarantor",
    "attachedSubjects": [{
        "id": "4d2d905f-8730-4d71-ae7c-xxxxxxxx", // tenant shell's subject ID
        "type": "applicant"
    }],
    "context": {
        "firstName": "Guarantor",
        "lastName": "Pro",
        "mobile": "07123456789",
        "email": "test-pro-product@test.com",
        "product": "Pro"
    },
    "rentalDetails": {
        "priceShare": 1200,
        "affordabilityRatio": 3.0
    }
}

API Outcomes

After the subject (the tenant or guarantor) has completed their initial referencing submission, they will move into one of the following states in Subject.Outcome.
These are:

  • Pending Submission - The applicant has not completed referencing yet.
  • In Review - The application is being reviewed by one of our Referencing Executives.
  • Awaiting Response - Following the completion of the applicant's bot journey, if Goodlord requires additional information from the applicant, they will be contacted and their outcome will move to this state.
  • Accepted - The applicant has met our referencing criteria.
  • Rejected - The applicant has not met our referencing criteria
  • Cancelled - The applicant's referencing has either expired due to them being inactive or the application has been deleted.

Please note: a subject can move between these depending on the information they have provided. They go from in.review and then awaiting.response, when the referencing team require further details.

Conditional Pass and Conditions Met: Explained

Referencing reports will show as a pass, a conditional pass, or a fail. For some situations, a Conditional Pass can be updated to a Conditions Met. We’ll cover that in the second part of this guide. If a report is a conditional pass, Goodlord recommends that the tenant pays the rent upfront, secures a suitable guarantor, or is not liable for the rent (i.e permitted occupier). There are several reasons why a report might be a conditional pass.

ID

An ID check will come back as a conditional pass if:

  • The ID is not supplied or is invalid
  • The ID does not comply with the right-to-rent guidelines (England only)
  • There is no proof of name change
  • No photo ID has been provided

The full list of acceptable, Right to Rent-compliant documents can be found at gov.uk. The condition of the ID section will always be to review the ID in person and to update the platform. Once you have seen the ID in person to corroborate that it belongs to the person who is being referenced, you are able to have the report section updated to show as Conditions Met.

Credit check

A credit check will come back as a conditional pass if:

  • The declared active CCJ totals less than £1,000.
  • The declared satisfied CCJ totals between £1,000 to £5,000.
  • The bankruptcy or IVA is satisfied within 1-6 years.
  • The tenant could not be located on the electoral roll.
  • The tenants live outside the UK.

If a tenant cannot be located on the electoral roll or lives outside of the UK, you can confirm the credit check by looking at documents that show proof of address (e.g. a bank or utility statement). Once you have seen suitable proof of address, you are able to have the report section updated to show as Conditions Met.

Income

An income check will come back as a conditional pass if:

  • The tenant is a student.
  • The tenant does not meet our affordability ratio (2.5 x the annual rent or 3.0 x for a guarantor).
  • The tenant has been self-employed for fewer than twelve months and does not have a submitted tax return form.
  • The tenant is unemployed.
  • The employer has not verified the income.
  • The tenant has not provided the necessary documents to verify their income.

The conditions that might be applied to the financial section of referencing include the tenant being required to have a guarantor, the tenant not being liable for rent or the combined affordability for the remaining tenants meeting the overall cost of the rent for the tenancy. Once these conditions have been met, there is no need to notify us of this on the Goodlord platform. The reference report will remain with an overall conditional pass.

Residential

A residential check will come back as a conditional pass if:

  • The rent was paid late
  • The tenancy could not be verified
  • There is minor damage to the property.

Find out more about our referencing process from our criteria-related articles. The possible conditions for the residential section include adding a guarantor to the tenants or the tenant not being liable for the rent (Added as a permitted occupier rather than a tenant). Once the condition has been met, you do not need to notify us of this. The reference report will remain with an overall conditional pass.

Overriding a conditional pass

Once the conditions for ID and Credit have been met, the public API has the capability for a user to inform Goodlord, at which point a report for that particular tenant or guarantor will be updated, and the new report sent back to you. This is explained in the Patch-Subject-Outcome-Conditions sections

Emails

An applicant may receive emails from Goodlord under various circustances. These can be overriden when creating a subject by managing Subject.Context.CommunicationPreferences.
The default communications happen when:

  • When an applicant (tenant or guarantor) or a referee is created in our system we will send them the initial referencing email containing the link to our bot journey. (provided that sendInitialTenantEmail is set to true)
  • When the applicant's email is changed, we will assume the original one was incorrect and re-send the initial referencing email (again, provided that sendInitialTenantEmail is set to true)
  • If the applicant has not completed their referencing we will send them daily reminders (Monday-Friday). Daily reminders expire after 7 days as the reference will be closed as unverified.
  • If one of our Referencing Executives identifies that further information is required, they will be sent an email requesting the appropriate information.

Document Types

There are different types of documents used to reference an individual. Documents are stored in Subject.Context.Documents.
The available document types and the category each relates to are in the following table:

Document Type Category Additional Info
Passport Identity Government-issued passport confirming identity and nationality.
Driving license Identity Driving licence used as proof of identity.
Student ID Identity Educational institution–issued ID confirming student status.
Identity card Identity General identity card used to verify personal identity.
UK Home Office Registration Cert Identity Official UK Home Office document confirming immigration and/or residency status.
UK Immigration Status Document Identity Document evidencing an individual’s legal immigration status in the UK.
EU Identity card Identity National identity card issued by an EU member state.
Selfie Identity Live facial image used for identity verification and fraud prevention.
Other identity document Identity Alternative identity document not covered by standard identity types.
Credas Report Identity Third-party identity and credit verification report from Credas.
Credas PEPs and Sanctions Report Identity Credas report checking politically exposed persons and sanctions lists.
additionalidentitydocument Identity Supplementary identity documentation provided when standard documents are insufficient.
taxReturn Income Official tax return showing declared income for a given period.
bankStatement Income Bank statement used to evidence income.
payslip Income Payslip confirming salary payments.
signedContractOfEmployment Income Signed employment contract confirming role, salary, and employment terms.
awardDocument Income Documentation evidencing awarded income, such as grants or stipends.
AdditionalIncomeDocument Income Supplementary documentation supporting additional income sources.
Proof of Address Residential Document confirming an individual’s residential address.
additionalresidentialdocument Residential Supplementary residential documentation supporting proof of address.
additionalCreditdocument Credit Supplementary credit-related documentation provided to support a credit assessment.
additionalDocument Other Additional supporting document not covered by a specific category.
Other Other Catch-all document type for uncategorised or miscellaneous files.
Individual Report Output Report Individual assessment or output report generated during processing.
Landlord Report Output Report Report generated for landlords summarising referencing outcomes.
Reference Report Output Report Report containing reference checks and verification results.

Touchpoints overview

When an application is going through referencing, we provide updates for noticeable changes or advancements in the process. These are called touchpoints, and they're a valuable way of keeping you informed and making our product more self-serve. Touchpoints begin once an applicant has submitted their reference and they finish when a final outcome has been given.

With the Goodlord Referencing API you can retrieve touchpoints for a referencing applicant using the Get Subject Touchpoints endpoint.

These comments are created for each section [identity, residential, income, credit (stated as category)] of referencing and can be authored by:

  • System - Automatically generated messages by the Goodlord system
  • Person - Comments made by referencing executives (internal Goodlord staff)
  • Agent - Comments made by letting agents

subjectId: The unique identifier for the referencing applicant

The author object contains information about who created the touchpoint:

  • type: The type of author (system, person, or agent) - this is the primary field
  • id: Internal Goodlord identifier, only present for authors of type "person" (referencing executives)
  • email: Email address, only present for authors of type "agent"

The following shows example responses from the Get Subject Touchpoints endpoint:

System Type Example - Automatically generated system message:

[
  {
    "id": "78230093-8035-4aad-81db-9221cd5019a0",
    "subjectId": "a6770136-63f0-4315-9d9e-3700329a4b91",
    "category": "residential",
    "author": {
      "type": "system"
    },
    "message": "We're awaiting additional information from applicant.",
    "createdAt": "2024-10-01T14:35:12.189Z"
  }
]

Person Type Example - Comment from a referencing executive:

[
  {
    "id": "6e10af0c-ae9c-4c80-ac09-aa9f253d5f97",
    "subjectId": "a6770136-63f0-4315-9d9e-3700329a4b91",
    "category": "income",
    "author": {
      "id": "df603e71-0e12-4ad3-b13b-02225563ac85",
      "type": "person"
    },
    "message": "As the applicant has recently started employment we are not able to accept the reference on this occasion",
    "createdAt": "2024-10-02T09:20:33.456Z"
  }
]

Touchpoints vs. Milestones

The way in which Touchpoints differ from Milestones is that:

  • Touchpoints act as internal notes and communications to provide additional context around certain stages of the applicants referencing.
  • Milestones are timestamps of different points in the applicant's referencing journey, from the subject's creation, to the completion of each section and the entire referencing journey.

Example - Subject Created

  {
    "type": "event",
    "event": "subject.created",
    "createdAt": "2026-01-01T09:00:00.000Z",
    "updatedAt": "2026-01-01T09:00:00.000Z",
  }

Example - Subject began referencing

  {
    "type": "event",
    "event": "subject.startedApplication",
    "createdAt": "2026-01-01T09:10:00.000Z",
    "updatedAt": "2026-01-01T09:10:00.000Z",
  }

Example - Subject finished providing proof of identity

  {
    "type": "event",
    "event": "subject.section.identity.completed",
    "createdAt": "2026-01-01T09:15:00.000Z",
    "updatedAt": "2026-01-01T09:15:00.000Z",
  }

Example - Subject completed entire bot journey

  {
    "type": "event",
    "event": "subject.journey.complete",
    "createdAt": "2026-01-01T09:20:00.000Z",
    "updatedAt": "2026-01-01T09:20:00.000Z",
  }

Example - Subject's outcome was determined as Accepted

  {
    "type": "FinalOutcome",
    "event": "subject.accepted",
    "createdAt": "2026-01-01T09:30:00.000Z",
    "updatedAt": "2026-01-01T09:30:00.000Z",
  }
Value has been copied successfully