Search
K
lodgement v1

Lodgement Case Summary

This API is used to get the lodgement case summary for an existing workspace

get
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases

Query Parameters

workspace_idstring(uuid)required

workspace-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
 
application/json

Download Lodgement Document - PDF

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

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

Query Parameters

document_typestringrequired

Document type Allowed Values: [‘TITLE_INFORMATION_DOCUMENT’]

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Response

application/octet-stream

OK

string
get/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/documents
 
application/octet-stream

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
 

Update Lodgement Application Attribute

This API is used to update the attribute values for a given lodgement application id

patch
https://api.pexa.co.uk/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

application_idstring(uuid)required

Application id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
transactionValuenumber

Example:100

mortgageDeedReferencestring

Example:DN100

mortgageDeedReferenceTypestring

Allowed values:
[PAPER, DIGITAL]

Match pattern:^(PAPER|DIGITAL)$

Example:PAPER

isEffectiveboolean

Example:true

Response

application/json

OK

applicationIdstring(uuid)read-only
applicationTypestring

Example:MORTGAGE_DEED

statusstringread-only
submittedAtstring(date-time)
submittedBystring
auditAttributesobject
Show Child Parameters
fileobject
Show Child Parameters
attributesobject
Show Child Parameters
patch/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}

Body

{}
 
application/json

Upload and Attach Document

This API is used to 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/lodgement-cases/{lodgement_case_id}/applications/{application_id}/attachments

Path Parameters

lodgement_case_idstring(uuid)required

Lodgement case id

application_idstring(uuid)required

Application 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,
EVIDENCE,
CORRESPONDENCE,
IDENTITY_EVIDENCE,
IDENTITY_FORM,
BIRTH_CERTIFICATE,
MARRIAGE_CERTIFICATE,
STATEMENT_OF_TRUTH,
STATUTORY_DECLARATION,
PG82_CERTIFICATE,
COMPANIES_HOUSE_CERTIFICATE,
COMPANIES_HOUSE_EVIDENCE]

Example:MORTGAGE_DEED

documentCategorystringrequired

Allowed values: [APPLICATION_DOCUMENT, SUPPORTING_DOCUMENT]

Example:APPLICATION_DOCUMENT

certificationTypestringrequired

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

Response

application/json

ACCEPTED

fileIdstring(uuid)required
post/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/applications/{application_id}/attachments

Body

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