Search
K
lodgement v1

Upload Document

This API is used to upload documents to workspace such as offer document as well as upload & attach a document to the lodgement application associated to the workspace, such as a mortgage deed.

Note: In the event of eDeed please update mortgageDeedReference and mortgageDeedReferenceType using Update Lodgement Application Attribute before uploading

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/files

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

multipart/form-data
filestringrequired

Allowed format: [PDF]

Example:sample_document.pdf

documentTypestringrequired

Allowed values: [MORTGAGE_DEED,
TR1,
RX3,
BIRTH_CERTIFICATE,
CORRESPONDENCE,
EVIDENCE,
IDENTITY_EVIDENCE,
IDENTITY_FORM,
MARRIAGE_CERTIFICATE,
STATEMENT_OF_TRUTH,
STATUTORY_DECLARATION,
MORTGAGE_OFFER,
REDEMPTION_STATEMENT,
PG82_CERTIFICATE,
COMPANIES_HOUSE_CERTIFICATE,
COMPANIES_HOUSE_EVIDENCE,
LAND_TRANSACTION_TAX,
STAMP_DUTY_LAND_TAX]

Example:MORTGAGE_DEED

applicationIdstring(uuid)

To attach the uploaded document to a specific application, the corresponding Application ID must be provided. This value is not required when uploading a document to Workspace without having to attach to an application.

Example:123e4567-e89b-12d3-a456-426614174000

documentCategorystringrequired

Allowed values: [APPLICATION_DOCUMENT,
SUPPORTING_DOCUMENT,
WORKSPACE_SUPPORTING_DOCUMENT]

Example:APPLICATION_DOCUMENT

certificationTypestring

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

Response

application/json

ACCEPTED

fileIdstring(uuid)required
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/files

Body

{ "file": "sample_document.pdf", "documentType": "MORTGAGE_DEED", "documentCategory": "APPLICATION_DOCUMENT" }
 
application/json

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

Match pattern:^[A-Za-z]{0,3}\d{1,6}$

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

Match pattern:^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

>= 1 characters

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

Match pattern:^[A-Za-z]{0,3}\d{1,6}$

Example:ABC123456

Example