v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

rental records

Retrieve rental recognition record

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.

get/rental-records

Response

Successful Rental Record Response

metaobject

Example response

{
  "data": [
    {
      "id": "bf8dcceb-6550-48cc-8ba8-2779c29cdfa9",
      "userId": "61a0b1f535c30072d101b05f",
      "title": "Title",
      "firstName": "firstName",
      "lastName": "lastName",
      "birthdate": "2000-11-19",
      "addressLine1": "First address line",
      "addressLine2": "Second address line",
      "addressLine3": "Third address line",
      "addressLine4": "Fourth address line",
      "postalCode": "CA12345",
      "tenancyStartDate": "2020-11-19",
      "lastSubmittedDate": "2021-07-10",
      "rentalAmount": {
        "value": 10000,
        "currency": "GBP"
      },
      "rentalFrequency": "monthly",
      "seriesId": "9f0cb6a3-7fc6-54de-a855-aca4f821c100",
      "consentApprovedAt": "2020-11-20T11:39:44Z",
      "createdAt": "2021-11-26T10:13:48.529Z",
      "modifiedAt": "2021-11-26T10:13:48.529Z"
    }
  ]
}