API Reference

Create a rental recognition record for user

post
https://api.moneyhub.co.uk/v3/rental-records

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

Body Params
string
length ≤ 5

Title of the user the rental record belongs to.

string
required

First name of the user the rental record belongs to.

string
required

Last name of the user the rental record belongs to.

date
required

Date of birth of the user the rental record belongs to.

string
required

First line of the rented address.

string | null

Second line of the rented address.

string | null

Third line of the rented address.

string | null

Fourth line of the rented address.

string
required
length ≤ 8

Postal code of rented address.

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.

string
enum
required

Frequency of the rental payments e.g. monthly.

Allowed:
string
required

The unique identity of the regular transaction series.

Responses

Updated about 1 month ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago