---
title: "Retrieve rental recognition record"
method: GET
path: "/rental-records"
tags: ["rental records"]
---

# Retrieve rental recognition record

`GET /rental-records`

## Request

- Base URL: `https://api.moneyhub.co.uk/v3`
- URL: `https://api.moneyhub.co.uk/v3/rental-records`
- Auth: API key in header `Authorization`

Requires **rental_records:read** scope. Please note that a user will only have one rental recognition record. The rental record returned will be for the authenticated user.

## Response `200`

Successful Rental Record Response

- object
  - `data` RentalRecords[]
    - `id` string, required: The unique identifier for the rental recognition record.
    - `userId` string, required: The unique identifier for the user.
    - `title` string: Title of the user the rental record belongs to.
    - `firstName` string, required: First name of the user the rental record belongs to.
    - `lastName` string, required: Last name of the user the rental record belongs to.
    - `birthdate` string, date, required: Date of birth of the user the rental record belongs to.
    - `addressLine1` string, required: First line of the rented address.
    - `addressLine2` string, nullable: Second line of the rented address.
    - `addressLine3` string, nullable: Third line of the rented address.
    - `addressLine4` string, nullable: Fourth line of the rented address.
    - `postalCode` string, required: Postal code of rented address.
    - `tenancyStartDate` string, date, required: Start date of the tenancy agreement.
    - `rentalAmount` object, required: The value of the balance in minor units of the currency, eg. pennies for GBP.
      - `value` number: The amount of the regular rental transactions in minor units of the currency e.g. pennies for GBP.
      - `majorUnits` integer: The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer: The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string: The currency of the amount.
    - `rentalFrequency` 'weekly' | 'fortnightly' | 'monthly', required: Frequency of the rental payments e.g. monthly.
    - `seriesId` string, required: The unique identity of the regular transaction series.
    - `createdAt` string, date-time, required: The date at which the rental record was added.
    - `modifiedAt` string, date-time, required: The date at which the rental was modified.
    - `lastSubmittedDate` string, date, nullable: The date rental record data was last sent to Experian.
    - `consentApprovedAt` string, date-time, nullable: The date on which consent to send data to Experian was given.
  - `links` Links
    - `next` string, uri: The url to retrieve the next page of results from
    - `prev` string, uri: The url to retrieve the previous page of results from
    - `self` string, uri, required: The url of the current resource(s)
  - `meta` object

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/revisions/2e08b5dbee56?raw)