lodgement v2

Lodgement

Lodgement Case Summary

This API is to get the lodgement case summary for an existing workspace. Additionally, this version also supports Conveyancer Certified Electronic Signature.

get
https://api.pexa.co.uk/partner/api/platformconnect/v2/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/v2/lodgement-cases
 
application/json

Update Lodgement Application Attribute

This API is used to update the attribute values for a given lodgement application id. Additionally, this version also supports Conveyancer Certified Electronic Signature.

patch
https://api.pexa.co.uk/partner/api/platformconnect/v2/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:
[STANDARD, DIGITAL]

Match pattern:^(STANDARD|DIGITAL)$

Example:STANDARD

signatureobject
Show Child Parameters
isEffectiveboolean

Example:true

considerationTypestring

Allowed values: [MONETARY_CONSIDERATION, NO_MONETARY_CONSIDERATION, TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME]

Match pattern:^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$

Example:MONETARY_CONSIDERATION

Response

application/json

OK

applicationIdstring(uuid)read-only
applicationTypestring

Example:MORTGAGE_DEED

statusstringread-only
submittedAtstring(date-time)
submittedBystring
auditAttributesobject
Show Child Parameters
attributesOne Of
Variant 1object
Show Child Parameters
patch/partner/api/platformconnect/v2/lodgement-cases/{lodgement_case_id}/applications/{application_id}

Body

{}
 
application/json

LodgementSummaryResponseV2

object
recordsarray[object]
Show Child Parameters
Example

LodgementCaseItemV2

object
lodgementCaseIdstring(uuid)required
lodgementCaseStatusstringrequiredread-only

Allowed values: [CREATED, PREPARED, INITIATED, LODGED, REGISTERED, REQUISITIONED, REQUISITION_SUBMITTED, PARTIALLY_REGISTERED, REGISTRATION_REJECTED, REGISTERED_EXTERNALLY, RESUBMISSION_PREPARED]

Match pattern:^(CREATED|PREPARED|INITIATED|LODGED|REGISTERED|REQUISITIONED|REQUISITION_SUBMITTED|PARTIALLY_REGISTERED|REGISTRATION_REJECTED|REGISTERED_EXTERNALLY|RESUBMISSION_PREPARED)$

workspaceIdstring(uuid)
workspaceReferenceIdstring
lastTitleSearchStatusstring

Allowed values: [INITIATED, PENDING, SUCCESS, FAILED]

Match pattern:^(INITIATED|PENDING|SUCCESS|FAILED)$

transactionTypestring

Allowed values: [PURCHASE, REMORTGAGE]

Match pattern:^(PURCHASE|REMORTGAGE)$

applicationsarray[object]
Show Child Parameters
auditAttributesobject
Show Child Parameters
titlesarray[object]
Show Child Parameters
Example

LodgementApplicationItemV2

object
applicationIdstring(uuid)read-only
applicationTypestring

Example:MORTGAGE_DEED

statusstringread-only
submittedAtstring(date-time)
auditAttributesobject
Show Child Parameters
fileobject
Show Child Parameters
attributesOne Of
Variant 1object
Show Child Parameters
partiesarray[object]
Show Child Parameters
Example