Search
K
instruction v1

CreateInstructionRequest

object
routingConfigobjectrequired

Information used to determine where to route the instruction

Show Child Parameters
instructionsDetailsobjectrequired
Show Child Parameters
Example

RoutingConfig

object

Information used to determine where to route the instruction

assignedPanelManagerstring

The assigned panel manager Allowed Values: [ SMOOVE]

Match pattern:^(SMOOVE)$

assignedPanelLawFirmstring

Panel reference held by the Panel Manager for the law firm

<= 50 characters

assignedLawFirmstring

The actual law firm name Allowed Values: [ OPTIMA ]

Match pattern:^(OPTIMA)$

pexaEligibleboolean

Indicates if the funds should be settled by PEXA

Example

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