Search
K
workspace v1

Workspace

v1OAS 3.0

This API specification includes all workspace-related experience endpoints for creating, managing, and working with workspaces

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:purchase_workspaces - Permission to create purchase workspace
  • x-api:create:remortgage_workspaces - Permission to create remortgage workspace
  • x-api:cancel:workspaces - Permission to cancel the workspace
  • add:law_firm_reference - add law firm reference
  • add:legal_representation_details - add legal representation details
  • view:workspaces - view workspace
  • create:title_change_request - create title change request
  • edit:workspace_parties - edit workspace parties
  • x-api:add:legal_representation_details - Permission to add party representation
  • x-api:edit:external_law_firm_details - Permission to update external law firm representation
  • create:workspaces - Permission to create workspaces
  • edit:workspaces - Permission to edit workspaces
  • edit:lodgement_proprietors - Permission to edit proprietors linked to lodgement case
  • view:lodgement_proprietors - Permission to view proprietors linked to lodgement case
  • add:workspace_participants - Permission to add workspace participants
  • edit:external_law_firm_details - Permission to edit external law firm details
  • edit:law_firm_reference - Permission to edit law firm reference

Create Workspace

This API is used to create a new purchase and remortgage workspace using a simple data set, returning the newly created PEXA workspace UUID

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

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
transactionTypestringrequired

Allowed values: [PURCHASE, REMORTGAGE]

Match pattern:^(PURCHASE|REMORTGAGE)$

referencestringrequired

>= 1 characters<= 25 characters

Example:109344235

propertyobjectrequired
Show Child Parameters
partiesOne Of
arrayrequired

minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties

Variant 1object
Show Child Parameters
participantsarray[object]required

>= 1 items<= 1 items

Show Child Parameters

Response

application/json

ACCEPTED

referencestringrequired

>= 1 characters<= 25 characters

Example:109344235

workspaceIdstring(uuid)
workspaceReferenceIdstring

Example:PEXA210000012

post/partner/api/platformconnect/v1/workspaces

Body

{ "transactionType": "REMORTGAGE", "reference": "109344235", "property": { "jurisdiction": "ENGLAND_WALES", "securityAddress": { "name": "1 The House", "number": "123a", "flat": "Flat 32", "street": "Huddersfield", "town": "West Yorkshire", "postcode": "M16 0RA" } }, "parties": [ { "type": "INDIVIDUAL", "role": "BORROWER", "partyDetails": { "forenames": "James", "surname": "Smith" } } ], "participants": [ { "id": "6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd", "role": "INCOMING_LENDER_REPRESENTATIVE" } ] }
 
application/json

Create Remortgage Workspace

This API is used to create a new workspace using a simple data set, returning the newly created PEXA workspace UUID

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

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
referencestringrequired

>= 1 characters<= 25 characters

Example:109344235

propertyobjectrequired
Show Child Parameters
partiesOne Of
arrayrequired

minItems: 1 - Organisation borrower Party or 1 - Individual borrower Parties maxItems: 1 - Organisation borrower Party or 4 - Individual borrower Parties

Variant 1object
Show Child Parameters
participantsarray[object]required

>= 1 items<= 1 items

Show Child Parameters

Response

application/json

ACCEPTED

referencestringrequired

>= 1 characters<= 25 characters

Example:109344235

workspaceIdstring(uuid)
workspaceReferenceIdstring

Example:PEXA210000012

post/partner/api/platformconnect/v1/remortgage/workspaces

Body

{ "reference": "109344235", "property": { "jurisdiction": "ENGLAND_WALES", "securityAddress": { "name": "1 The House", "number": "123a", "flat": "Flat 32", "street": "Huddersfield", "town": "West Yorkshire", "postcode": "M16 0RA" } }, "parties": [ { "type": "INDIVIDUAL", "role": "BORROWER", "partyDetails": { "forenames": "James", "surname": "Smith" } } ], "participants": [ { "id": "6c6cf8b9-9c9c-4ef4-be70-da426c1d19dd", "role": "CONVEYANCER" } ] }
 
application/json