Search
K
lodgement v1

Submit Lodgement Case to HMLR

This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case.

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

NO CONTENT - Lodgement case submitted successfully

post/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit
 

Download Title Document - JSON

This API is used to download document content in JSON format from an existing workspace

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/titles/{title_id}/title-documents

Query Parameters

document_typestring

Supported document types in title

Allowed values:TITLE_REGISTERTITLE_INFORMATION_DOCUMENTEARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

title_idstring(uuid)required

Title id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/json

OK

recordsarray[object]
Show Child Parameters
get/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/titles/{title_id}/title-documents
 
application/json

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

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
titleNumberstringrequired

Title number format: optional 0-3 letters + 1-6 digits

Example:ABC123456

Response

application/json

ACCEPTED

messagestringrequired

Example:Request taken up for processing

post/partner/api/platformconnect/v1/workspaces/{workspace_id}/titles

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
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

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

Body

{ "action": "APPROVE", "approvedBy": "approver@lawfirm.com" }
 
application/json

CreateTitleRequest

object
titleNumberstringrequired

Title number format: optional 0-3 letters + 1-6 digits

Example:ABC123456

Example