Search
K
lodgement v3

Lodgement

v3OAS 3.0

This API product gives all the possible functionalities we can perform on lodgement like case summary, document upload/download, and application attribute updates

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • x-api:view:lodgement_summary - View lodgement summary
  • view:lodgement_cases - View lodgement cases
  • view:lodgement_documents - View lodgement documents
  • view:lodgement_titles - View lodgement titles

Lodgement Case Summary V3

This API is to get the lodgement case summary for an existing workspace. This version supports expanded application types (CHANGE_OF_NAME, CANCEL_A_RESTRICTION, TRANSFER_OF_WHOLE, DISCHARGE), enhanced document structure with certification type, and extended party roles.

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

LodgementSummaryResponseV3

object
recordsarray[object]
Show Child Parameters
Example

LodgementCaseItemV3

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