InstructionsDetails
objectThe lender held reference for the mortgage application
>= 1 characters<= 40 characters
The amount of the loan
>= 1
Allowed values: [ PURCHASE, REMORTGAGE ]
Match pattern:^(PURCHASE|REMORTGAGE)$
Level of service required for this instruction Allowed values: [ STANDARD, PREMIER ]
Match pattern:^(STANDARD|PREMIER)$
Show Child Parameters
Show Child Parameters
One OfInformation about the applicants, introducer, and outgoing lender (up to 4 applicants plus introducer and outgoing lender as needed)
Show Child Parameters
Indicates if this is a mortgage prisoner
Lender
objectThe lender account number
The lender sort code
Property
objectThe jurisdiction of the property (REQUIRED field as of v1.1.0) Allowed values: [ENGLAND_WALES, SCOTLAND, NORTHERN_IRELAND]
Match pattern:^(ENGLAND_WALES|SCOTLAND|NORTHERN_IRELAND)$
The country where the property is located Allowed values: [ENGLAND, WALES, SCOTLAND, NORTHERN_IRELAND]
Match pattern:^(ENGLAND|WALES|SCOTLAND|NORTHERN_IRELAND)$
Show Child Parameters
Indicates if the property is unencumbered
The tenure of the property Allowed values: [ FREEHOLD, LEASEHOLD]
Match pattern:^(FREEHOLD|LEASEHOLD)$
Type of occupancy for the property Allowed values: [ OWNER_OCCUPIED, BUY_TO_LET, SECOND_HOME, HOLIDAY_LET ]
Match pattern:^(OWNER_OCCUPIED|BUY_TO_LET|SECOND_HOME|HOLIDAY_LET)$
Indicates if the property is a new build
Address
objectFlat/apartment number
Building name
House/building number
Street name
Town/city
Match pattern:^(([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$
>= 6 characters<= 8 characters
Example:M16 0RA
Locality
County name
Postcode
stringMatch pattern:^(([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$
>= 6 characters<= 8 characters