Search
K
instruction v1

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

UpdateParty

object
partyIdstring(uuid)required

Unique identifier for the party associated with the instruction

addressesarray[object]

Address information for the party

Show Child Parameters
Example

UpdateIndividualParty

object
partyIdstring(uuid)required

Unique identifier for the party associated with the instruction

addressesarray[object]

Address information for the party

Show Child Parameters
partyDetailsobject
Show Child Parameters
typestringrequired

Allowed Values: [INDIVIDUAL]

Match pattern:^(INDIVIDUAL)$

Example