X-Request-Correlation-Idstring
The unique identifier for the request
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
Body
application/json
Body
application/json
transactionTypestringrequired
Allowed values: [PURCHASE, REMORTGAGE]
Match pattern:^(PURCHASE|REMORTGAGE)$
referencestringrequired
>= 1 characters<= 25 characters
Example:109344235
propertyobjectrequired
Show Child Parameters
parties
One Ofarrayrequired
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
Response
application/json
ACCEPTED
referencestringrequired
>= 1 characters<= 25 characters
Example:109344235
workspaceIdstring(uuid)
workspaceReferenceIdstring
Example:PEXA210000012
post/partner/api/platformconnect/v1/workspaces
Authentication
Headers
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
Body
application/json
referencestringrequired
>= 1 characters<= 25 characters
Example:109344235
propertyobjectrequired
Show Child Parameters
parties
One Ofarrayrequired
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
Response
application/json
ACCEPTED
referencestringrequired
>= 1 characters<= 25 characters
Example:109344235
workspaceIdstring(uuid)
workspaceReferenceIdstring
Example:PEXA210000012
post/partner/api/platformconnect/v1/remortgage/workspaces
Authentication
Headers
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
Cancel Workspace
This API is used to cancel the created workspaces which are no longer required by the integrators.
delete
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/cancel-workspace
Path Parameters
workspace_idstring(uuid)required
Workspace id
Headers
X-Request-Correlation-Idstring
The unique identifier for the request
Body
application/json
Body
application/json
cancellationReasonstringrequired
Reason to cancel the workspace.
Allowed values:
[APPLICANT_DECIDED_NOT_TO_PROCEED, TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE, LAW_FIRM_NO_LONGER_ACTING, LENDER_DECIDED_NOT_TO_PROCEED, LOAN_INVOLVES_MULTIPLE_TITLES, OTHER]
Match pattern:^(APPLICANT_DECIDED_NOT_TO_PROCEED|TITLE_COMPLICATIONS_OUTSIDE_PEXA_SCOPE|LAW_FIRM_NO_LONGER_ACTING|LENDER_DECIDED_NOT_TO_PROCEED|LOAN_INVOLVES_MULTIPLE_TITLES|OTHER)$
Example:APPLICANT_DECIDED_NOT_TO_PROCEED
cancellationNotesForOtherstring
Mandatory when cancellationReason “OTHER” is provided
>= 1 characters<= 100 characters
Example:Title complications outside PEXA scope
Response
Response
NO CONTENT
delete/partner/api/platformconnect/v1/workspaces/{workspace_id}/cancel-workspace
Authentication
Path Parameters
Headers
Body
{
"cancellationReason": "APPLICANT_DECIDED_NOT_TO_PROCEED"
}
Add Participant Reference
This API allows the user to add a reference number to the workspace
post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/references
Path Parameters
workspace_idstring(uuid)required
Workspace id
Headers
X-Request-Correlation-Idstring
The unique identifier for the request
Body
application/json
Body
application/json
representativeIdstring(uuid)
referenceNumberstringrequired
>= 1 characters<= 25 characters
Example:123456
representativeRolestringrequired
Representative role: [BORROWER_REPRESENTATIVE, INCOMING_LENDER, INCOMING_LENDER_REPRESENTATIVE, WORKSPACE_LAW_FIRM, BUYER_REPRESENTATIVE, OUTGOING_PROPRIETOR_REPRESENTATIVE]
Note - Representative role WORKSPACE_LAW_FIRM will be replaced with INCOMING_LENDER_REPRESENTATIVE soon
Match pattern:^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$
Example:BORROWER_REPRESENTATIVE
Response
application/json
Response
application/json
OK
referenceIdstring(uuid)read-only
representativeIdstring(uuid)
referenceNumberstringrequired
>= 1 characters<= 25 characters
Example:123456
representativeRolestringrequired
Representative role: [BORROWER_REPRESENTATIVE, INCOMING_LENDER, INCOMING_LENDER_REPRESENTATIVE, WORKSPACE_LAW_FIRM, BUYER_REPRESENTATIVE, OUTGOING_PROPRIETOR_REPRESENTATIVE]
Note - Representative role WORKSPACE_LAW_FIRM will be replaced with INCOMING_LENDER_REPRESENTATIVE soon
Match pattern:^(BORROWER_REPRESENTATIVE|INCOMING_LENDER|INCOMING_LENDER_REPRESENTATIVE|WORKSPACE_LAW_FIRM|BUYER_REPRESENTATIVE|OUTGOING_PROPRIETOR_REPRESENTATIVE)$
Example:BORROWER_REPRESENTATIVE
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/references
Authentication
Path Parameters
Headers
Body
{
"referenceNumber": "123456",
"representativeRole": "BORROWER_REPRESENTATIVE"
}
application/json
Get Workspace Details
This API allows you to get existing workspace data by providing the PEXA workspace ID generated on workspace creation
get
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}
Path Parameters
workspace_idstring(uuid)required
Workspace id
Headers
X-Request-Correlation-Idstring
The unique identifier for the request
Response
application/json
Response
application/json
OK
workspaceIdstring(uuid)
workspaceReferenceIdstring
Example:PEXA210000012
statusstring
Allowed values: [CREATED, PREPARED, FUNDS_AUTHORISED, FUNDS_EXCHANGED, LODGED, REQUISITIONED, CLOSED, CANCELLED]
Match pattern:^(CREATED|PREPARED|FUNDS_AUTHORISED|FUNDS_EXCHANGED|LODGED|REQUISITIONED|CLOSED|CANCELLED)$
transactionTypestring
Transaction Type:
- REMORTGAGE
- PURCHASE
Match pattern:^(REMORTGAGE|PURCHASE)$
referencestring
Example:109344235
jurisdictionstring
Jurisdiction:
ENGLAND_WALES- England/Wales
Match pattern:^(ENGLAND_WALES)$
Example:ENGLAND_WALES
createdAtstring(date-time)
completionDatestring(2022-08-01)
securityAddressobject
Show Child Parameters
partiesarray[object]
Show Child Parameters
referencesarray[object]
Show Child Parameters
readyForApprovalboolean
flag to indicate if the workspace is ready to be approved status.
Default:false
participantsarray[object]
Show Child Parameters
canBeUnapprovedboolean
flag to indicate if the workspace can be unapproved.
Default:false
hardLockedboolean
workspace hardlocked status.
Default:false
isLockedboolean
flag to indicate if the workspace can be soft locked.
Default:false
canBeCancelledboolean
flag to indicate if the workspace can be cancelled.
Default:false
borrowersValidationStatusstring
Allowed values: [VALID, INVALID, PENDING, COUNT_INVALID, TYPE_INVALID, NOT_REQUIRED, UNSUPPORTED_TYPE]
Match pattern:^(VALID|INVALID|PENDING|COUNT_INVALID|TYPE_INVALID|NOT_REQUIRED|UNSUPPORTED_TYPE)$
remarksobject
Show Child Parameters
transferOfEquityboolean
flag to indicate if the workspace features transfer of equity
Default:false
subscriberIdstring(uuid)
Subscriber Id of workspace creator
get/partner/api/platformconnect/v1/workspaces/{workspace_id}
Authentication
Path Parameters
Headers
application/json