Gurantor 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 referencin g 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
}
}