Search
K
instruction v1

Lender Instruction

v1OAS 3.0

This API provides access to PEXA Group services, enabling lenders to create case instructions via API.

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • x-api:create:instructions - Create instructions
  • x-api:edit:instructions - Update instructions
  • x-api:cancel:instructions - Cancel instructions

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

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