Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I use the V4 Referencing API to manage pre-tenancy referencing?

The V4 Referencing API enables third-party referencing agencies and automated screening systems to retrieve pending tenant applications and attach completed referencing documents. All endpoints are at https://live-api.letmc.com/v4/referencing/.

The V4 Referencing API is designed for third-party referencing providers, tenant screening services, and automated referencing systems that need to integrate with agentOS pre-tenancy workflows.

Referencing workflow

  1. Get branches — GET /v4/referencing/{shortName}/company/branches/{offset}/{count} Understand the client structure and identify processing territories.
  2. Get incomplete applications — GET /applications/{branchID}/{offset}/{count} Returns all tenancy applications for the specified branch that require referencing — those with incomplete reference status, pending screening, or awaiting documents. Referencing agencies can poll this endpoint regularly to identify new work.
  3. Attach referencing documents — PATCH /applications/{applicationID}/documents Submit completed referencing documents to a tenant application. Automatically updates the application status upon successful attachment. Supported document types: credit reports, employment references, landlord references, ID verification, financial statements, character references.

Application data available

Each application record includes:

  • Tenant personal details and contact information
  • Employment history
  • Current referencing status and outstanding requirements
  • Associated property and tenancy details
  • Application submission dates and referencing deadlines
  • Branch coordinator contact information

Branch and custom field endpoints

  • Specific branch: GET /company/branches/{branchID}
  • Get custom field definition: GET /company/object/{objectID}/customfield
  • Get custom field value: GET /company/objects/{objectID}/{fieldID}/value
  • Set custom field value: POST /company/objects/{objectID}/{fieldID}/customfield

Test with Swagger: Select "V4.Referencing" from the tier dropdown. Start with the branches endpoint to understand the client structure, then retrieve sample applications before testing document uploads.