document_typestring
Supported document types in title
Allowed values:TITLE_REGISTERTITLE_INFORMATION_DOCUMENTEARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT
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
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
Response
application/json
OK
recordsarray[object]
Show Child Parameters
get/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/titles/{title_id}/title-documents
Authentication
Path Parameters
Query Parameters
Headers
application/json
LodgementApprovalsRequest
objectactionstringrequired
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
LodgementApprovalsResponse
objectapprovedAtstring(date-time)
Timestamp when the approval action was performed
Example:2025-05-07T10:01:36.372Z
approvedBystring(email)
Email address of the user who performed the approval action
Example:approver@lawfirm.com
statusstring
Current status of the lodgement documents
values: [APPROVED, PREPARED]
Example:APPROVED
Example
LodgementSummaryResponse
objectrecordsarray[object]
Show Child Parameters
Example
LodgementCaseItem
objectlodgementCaseIdstring(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