Search
K
lodgement v1

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

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

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

LodgementApprovalsRequest

object
actionstringrequired

Action to perform on lodgement applications
Allowed values: [APPROVE, UNAPPROVE]

Match pattern:^(APPROVE|UNAPPROVE)$

Example:APPROVE

workspaceIdstring(uuid)required

The workspace ID for which to approve/unapprove lodgement applications

Example:4gb85f64-5717-4562-b3fc-2c963f66afa6

approvedBystring(email)required

Email address of the user performing the approval action

Example:approver@lawfirm.com

Example