Search
K
instruction v1

OrganisationPartyResponse

object
partyIdstring(uuid)

Unique identifier for the party

rolestringrequired

Allowed Values: [BORROWER, BUYER, INTRODUCER, OUTGOING_LENDER]

Match pattern:^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$

typestringrequired

Allowed Values: [ORGANISATION]

Match pattern:^(ORGANISATION)$

partyDetailsobjectrequired
Show Child Parameters
Example

Forenames

string

Forename is required for Individual BORROWER and BUYER parties

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 90 characters

Example

Surname

string

Surname is required for Individual BORROWER and BUYER parties

Match pattern:^[A-Za-z][A-Za-z\ - ']*$

>= 1 characters<= 50 characters

Example

UpdateInstructionRequest

object
loanAmountnumber(double)

The amount of the loan

>= 1

propertyobject
Show Child Parameters
partiesOne Of
array

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

Variant 1object
Show Child Parameters
mortgagePrisonerboolean

Indicates if this is a mortgage prisoner

Example

UpdateProperty

object
unencumberedboolean

Indicates if the property is unencumbered

newBuildboolean

Indicates if the property is a new build

addressobject
Show Child Parameters
Example