Search
K
instruction v1

InstructionsDetails

object
referencestringrequired

The lender held reference for the mortgage application

>= 1 characters<= 40 characters

loanAmountnumber(double)

The amount of the loan

>= 1

transactionTypestringrequired

Allowed values: [ PURCHASE, REMORTGAGE ]

Match pattern:^(PURCHASE|REMORTGAGE)$

serviceLevelstring

Level of service required for this instruction Allowed values: [ STANDARD, PREMIER ]

Match pattern:^(STANDARD|PREMIER)$

lenderobject
Show Child Parameters
propertyobjectrequired
Show Child Parameters
partiesOne Of
arrayrequired

Information about the applicants, introducer, and outgoing lender (up to 4 applicants plus introducer and outgoing lender as needed)

Variant 1object
Show Child Parameters
mortgagePrisonerboolean

Indicates if this is a mortgage prisoner

Example

Lender

object
accountNumberstring

The lender account number

sortCodestring

The lender sort code

Example

Property

object
jurisdictionstring

The jurisdiction of the property Allowed values: [ENGLAND_WALES, SCOTLAND, NORTHERN_IRELAND]

Match pattern:^(ENGLAND_WALES|SCOTLAND|NORTHERN_IRELAND)$

countrystring

The country where the property is located Allowed values: [ENGLAND, WALES, SCOTLAND, NORTHERN_IRELAND]

Match pattern:^(ENGLAND|WALES|SCOTLAND|NORTHERN_IRELAND)$

addressobjectrequired
Show Child Parameters
unencumberedboolean

Indicates if the property is unencumbered

tenurestring

The tenure of the property Allowed values: [ FREEHOLD, LEASEHOLD]

Match pattern:^(FREEHOLD|LEASEHOLD)$

occupancyTypestring

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)$

newBuildboolean

Indicates if the property is a new build

Example

Address

object
flatstring

Flat/apartment number

namestring

Building name

numberstring

House/building number

streetstring

Street name

townstring

Town/city

postcodestringrequired

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

localitystring

Locality

countystring

County name

Example

Postcode

string

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