workspace_idstring(uuid)required
Workspace id
Add Title To Workspace
Add title to workspace to be retrieved from HMLR using Title number
post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/titles
Path Parameters
Headers
X-Request-Correlation-Idstring
The unique identifier for the request
Body
application/json
Body
application/json
titleNumberstringrequired
Title number format: optional 0-3 letters + 1-6 digits
Example:ABC123456
Response
application/json
Response
application/json
ACCEPTED
messagestringrequired
Example:Request taken up for processing
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/titles
Authentication
Path Parameters
Headers
Body
{
"titleNumber": "ABC123456"
}
application/json
Approve or Unapprove Lodgement Applications
This endpoint is used by conveyancing law firms to approve a lodgement case so the workspace can be prepared.
post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/lodgement-approvals
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
actionstringrequired
Action to perform on lodgement applications
Allowed values: [APPROVE, UNAPPROVE]
Match pattern:^(APPROVE|UNAPPROVE)$
Example:APPROVE
approvedBystringrequired
Email address of the user who performed the approval action
Example:approver@lawfirm.com
Response
application/json
Response
application/json
ACCEPTED
lodgementCaseIdstring(uuid)required
Lodgement case id for which the applications will be approved or unapproved
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/lodgement-approvals
Authentication
Path Parameters
Headers
Body
{
"action": "APPROVE",
"approvedBy": "approver@lawfirm.com"
}
application/json
CreateTitleRequest
objecttitleNumberstringrequired
Title number format: optional 0-3 letters + 1-6 digits
Example:ABC123456
Example
AcknowledgementResponse
objectmessagestringrequired
Example:Request taken up for processing
Example
LodgementApprovalsRequest
objectactionstringrequired
Action to perform on lodgement applications
Allowed values: [APPROVE, UNAPPROVE]
Match pattern:^(APPROVE|UNAPPROVE)$
Example:APPROVE
approvedBystringrequired
Email address of the user who performed the approval action
Example:approver@lawfirm.com
Example