Search
K
instruction v1

Create Instruction

This endpoint enables a lender to create a new case instruction with either the panel management firm or the allocated law firm.

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/instructions

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
routingConfigobjectrequired

Information used to determine where to route the instruction

Show Child Parameters
instructionsDetailsobjectrequired
Show Child Parameters

Response

application/json

CREATED

instructionIdstring(uuid)required

Unique identifier for the created instruction

workspaceIdstring(uuid)

Unique identifier for the associated PEXA workspace

partiesOne Of
array

Information about the applicants, introducer, and outgoing lender

Variant 1object
Show Child Parameters
post/partner/api/platformconnect/v1/instructions

Body

{ "routingConfig": { "assignedPanelManager": "SMOOVE", "assignedPanelLawFirm": "PANEL123", "pexaEligible": true }, "instructionsDetails": { "reference": "LENDER-REF-001", "loanAmount": 250000, "transactionType": "PURCHASE", "serviceLevel": "STANDARD", "lender": { "accountNumber": "12345678", "sortCode": "12-34-56" }, "property": { "jurisdiction": "ENGLAND_WALES", "country": "ENGLAND", "address": { "flat": "Flat 2", "name": "The Manor House", "number": "123", "street": "High Street", "town": "London", "postcode": "SW1A 1AA" }, "unencumbered": false, "tenure": "FREEHOLD", "occupancyType": "OWNER_OCCUPIED", "newBuild": false }, "parties": [ { "type": "INDIVIDUAL", "role": "BORROWER", "partyDetails": { "forenames": "John Michael", "surname": "Smith", "title": "Mr", "dateOfBirth": "1985-06-15", "mobile": 7123456789, "email": "john.smith@email.com" }, "addresses": [ { "type": "REGISTERED_ADDRESS", "details": { "flat": "Flat 2", "name": "The Manor House", "number": "123", "street": "High Street", "town": "London", "postcode": "SW1A 1AA" } } ] } ], "mortgagePrisoner": false } }
 
application/json

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