---
title: "Lodgement"
url: "https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/5d60a5b6-f880-49a9-9ffa-3fcd91fe7f8f"
---

# Lodgement

OpenAPI specification document.

```json
{"openapi":"3.0.1","info":{"title":"Lodgement","description":"This API product gives all the possible functionalities we can perform on lodgement like case summary, document upload/download, and application attribute updates","version":"v1","x-api-version":"1.1.0","x-pexa-products":["partner"],"x-pexa-segments":["lawfirms","lenders"],"x-idp-audience":"PexaPartnerAPI","x-idp-audience-identifier":"https://app.pexauk.co.uk/api/v1/pexa-partner"},"servers":[{"url":"https://api.pexa.co.uk","description":"API Gateway URL"}],"tags":[{"name":"Lodgement","description":"Lodgement Endpoints to perform operations on lodgement case summary, document upload/download, and application attribute updates"}],"paths":{"/partner/api/platformconnect/v1/workspaces/{workspace_id}/files":{"post":{"tags":["LodgementDocument"],"summary":"Upload Document","description":"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. <br><br> ***Note:*** In the event of eDeed please update mortgageDeedReference and mortgageDeedReferenceType using Update Lodgement Application Attribute before uploading ","operationId":"uploadFile","security":[{"oauth2":["x-api:create:attachments","x-api:add:workspace_files","add:lodgement_files","view:lodgement_documents"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","documentType","documentCategory"],"type":"object","properties":{"file":{"type":"string","format":"binary","example":"sample_document.pdf","description":"Allowed format: [`PDF`]\n"},"documentType":{"type":"string","example":"MORTGAGE_DEED","description":"Allowed values: [`MORTGAGE_DEED`,\n `TR1`,\n `RX3`,\n `BIRTH_CERTIFICATE`,\n `CORRESPONDENCE`,\n `EVIDENCE`,\n `IDENTITY_EVIDENCE`,\n `IDENTITY_FORM`,\n `MARRIAGE_CERTIFICATE`,\n `STATEMENT_OF_TRUTH`,\n `STATUTORY_DECLARATION`,\n `MORTGAGE_OFFER`,\n `REDEMPTION_STATEMENT`,\n `PG82_CERTIFICATE`,\n `COMPANIES_HOUSE_CERTIFICATE`,\n `COMPANIES_HOUSE_EVIDENCE`,\n `LAND_TRANSACTION_TAX`,\n `STAMP_DUTY_LAND_TAX`]\n"},"applicationId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"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."},"documentCategory":{"type":"string","example":"APPLICATION_DOCUMENT","description":"Allowed values: [`APPLICATION_DOCUMENT`,\n `SUPPORTING_DOCUMENT`,\n `WORKSPACE_SUPPORTING_DOCUMENT`]\n"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"}}}}},"required":true},"responses":{"202":{"description":"ACCEPTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"required":["fileId"],"properties":{"fileId":{"type":"string","format":"uuid"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Bad Request"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/documents":{"get":{"tags":["LodgementCase"],"summary":"Download Lodgement Document - PDF","description":"This API is used to download document content in PDF format from an existing workspace","security":[{"oauth2":["x-api:view:documents","view:lodgement_files"]}],"operationId":"getDocument","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"lodgement_case_id","in":"path","description":"Lodgement case id","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"query","name":"document_type","description":"Document type Allowed Values: ['TITLE_INFORMATION_DOCUMENT', 'EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT']\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary","example":"%PDF-1.4 % 1 0 obj << /Type /Catalog /Version /1.7 /Pages 2 0 R >> endobj 3 0 obj << /CreationDate (D:20230811125238+00'00') /Producer (openhtmltopdf.com) /Title (Mortgage Deed) >> endobj 2 0 obj << /Type /Pages /Kids [4 0 R] /Count 1 >> endobj 4 0 obj << /Type /Page /MediaBox [0.0 0.0 595.275 841.875] /Parent 2 0 R /Contents 5 0 R /Resources 6 0 R >> endobj 5 0 obj << /Length 2649 /Filter /FlateDecode >> stream ……… ……… ……… ……… endstream endobj 6 0 obj << /Font 7 0 R >> endobj 7 0 obj << /F1 8 0 R /F2 9 0 R >> endobj 8 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >> endobj 9 0 obj << /Type /Font /Subtype /Type1 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >> endobj xref 0 10 0000000000 65535 f 0000000015 00000 n 0000000192 00000 n 0000000078 00000 n 0000000249 00000 n 0000000365 00000 n 0000003089 00000 n 0000003122 00000 n 0000003163 00000 n 0000003260 00000 n trailer << /Root 1 0 R /Info 3 0 R /ID [<0C3941FE18ED1D13A75215A5CFC207E1> <0C3941FE18ED1D13A75215A5CFC207E1>] /Size 10 >> startxref 3362 %%EOF\n"}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/titles/{title_id}/title-documents":{"get":{"tags":["title"],"summary":"Download Title Document - JSON","description":"This API is used to download document content in JSON format from an existing workspace","operationId":"listTitleDocuments","security":[{"oauth2":["view:title_documents"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"lodgement_case_id","in":"path","description":"Lodgement case id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"title_id","in":"path","description":"Title id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"document_type","in":"query","description":"Title Document Type","schema":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]}}],"responses":{"200":{"description":"OK","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"titleDocumentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]},"fileId":{"type":"string","format":"uuid"},"documentAttributes":{"type":"object","properties":{"propertyAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}},"title":{"type":"object","properties":{"titleNumber":{"type":"string","example":"DN100"}}},"proprietorship":{"type":"object","properties":{"registeredProprietors":{"type":"array","items":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"chargeDate":{"type":"string","format":"date","example":"2021-01-30"},"registrationDate":{"type":"string","format":"date","example":"2021-01-30"},"chargeeParties":{"type":"array","items":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"additionalDetails":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}}}}}}}}}}}},"examples":{"TitleInformationDocumentJson":{"value":{"records":[{"titleDocumentId":"64c95d57-b54d-460f-9a85-ef3612f35a03","documentType":"TITLE_INFORMATION_DOCUMENT","fileId":"e24c1119-4f17-4f20-90f9-bcbfa4fdfa03","documentAttributes":{"propertyAddress":{"lineOne":"36 Lets B Avenue","lineTwo":"Bodmin"},"title":{"titleNumber":"WK500270"},"proprietorship":{"registeredProprietors":[{"individual":{"forenames":"Sidney","surname":"Youngblood"},"addresses":[{"lineOne":"5 Cromwell Street","lineTwo":"Gloucester","lineThree":"Gloucestershire","postcode":"GL1 1RE"}]}]},"charges":[{"chargeDate":"2012-05-21","registrationDate":"2012-05-22","chargeeParties":[{"organizationName":"Abbey National PLC","address":{"lineOne":"Deeds Services","lineTwo":"101 Midsummer Boulevard","lineThree":"Milton Keynes","postcode":"MK9 1AA"}}],"additionalDetails":{"restrictionDetails":[{"chargeRestriction":{"reason":"RESTRICTION: No disposition","chargeParty":"Abbey National PLC","chargeDate":"2012-05-21"}}]}}]}}]},"summary":"List Title Documents Json Response"}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"document_type","message":"document_type is not in valid format"},{"field":"lodgement_case_id","message":"lodgement_case_id is not in valid format"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not Found"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit":{"post":{"tags":["LodgementCase"],"summary":"Submit Lodgement Case to HMLR","description":"This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case.","operationId":"submitLodgementCaseToHmlr","security":[{"oauth2":["x-api:submit:lodgement_applications","submit:lodgement_applications"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"lodgement_case_id","in":"path","description":"Lodgement case id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"NO CONTENT - Lodgement case submitted successfully","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Bad Request"}]}}}},"401":{"description":"UNAUTHORIZED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Unauthorized"}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Forbidden"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not Found"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/lodgement-approvals":{"post":{"tags":["LodgementApproval"],"summary":"Approve or Unapprove Lodgement Applications","description":"This endpoint is used by conveyancing law firms to approve a lodgement case so the workspace can be prepared.","operationId":"approveLodgementApplications","security":[{"oauth2":["x-api:approve:lodgement_applications","x-api:unapprove:lodgement_applications","view:workspaces","view:lodgement_cases"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["action","approvedBy"],"type":"object","properties":{"action":{"type":"string","pattern":"^(APPROVE|UNAPPROVE)$","description":"Action to perform on lodgement applications <br> Allowed values: [`APPROVE`, `UNAPPROVE`]\n","example":"APPROVE"},"approvedBy":{"type":"string","description":"Email address of the user who performed the approval action","example":"approver@lawfirm.com"}}}}},"required":true},"responses":{"202":{"description":"ACCEPTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"required":["lodgementCaseId"],"properties":{"lodgementCaseId":{"type":"string","format":"uuid","description":"Lodgement case id for which the applications will be approved or unapproved"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"field":"action","message":"action must be either APPROVE or UNAPPROVE"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not Found"}]}}}},"422":{"description":"UNPROCESSABLE ENTITY","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Lodgement case status must be in PREPARED state for approval"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}},"/partner/api/platformconnect/v1/workspaces/{workspace_id}/titles":{"post":{"tags":["title"],"summary":"Add Title To Workspace","description":"Add title to workspace to be retrieved from HMLR using Title number","operationId":"addTitle","security":[{"oauth2":["x-api:add:lodgement_titles"]}],"parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["titleNumber"],"type":"object","properties":{"titleNumber":{"type":"string","description":"Title number format: optional 0-3 letters + 1-6 digits","example":"ABC123456"}}}}},"required":true},"responses":{"202":{"description":"ACCEPTED","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","example":"Request taken up for processing"}}}}}},"400":{"description":"BAD REQUEST","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":{"message":"Incorrect title number format"}}}}},"401":{"description":"UNAUTHORIZED - Missing or invalid authentication token","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":{"message":"Unauthorised"}}}}},"403":{"description":"FORBIDDEN","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Forbidden"}]}}}},"404":{"description":"NOT FOUND","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Not Found"}]}}}},"500":{"description":"INTERNAL SERVER ERROR","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Internal Server Error"}]}}}},"503":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}}}},"components":{"parameters":{"TitleDocumentType":{"name":"document_type","in":"query","description":"Title Document Type","schema":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]}},"TitleId":{"name":"title_id","in":"path","description":"Title id","required":true,"schema":{"type":"string","format":"uuid"}},"X-Request-Correlation-Id":{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},"WorkspaceId":{"name":"workspace_id","in":"path","description":"Workspace id","required":true,"schema":{"type":"string","format":"uuid"}},"LodgementCaseId":{"name":"lodgement_case_id","in":"path","description":"Lodgement case id","required":true,"schema":{"type":"string","format":"uuid"}}},"examples":{"TitleInformationDocumentJson":{"value":{"records":[{"titleDocumentId":"64c95d57-b54d-460f-9a85-ef3612f35a03","documentType":"TITLE_INFORMATION_DOCUMENT","fileId":"e24c1119-4f17-4f20-90f9-bcbfa4fdfa03","documentAttributes":{"propertyAddress":{"lineOne":"36 Lets B Avenue","lineTwo":"Bodmin"},"title":{"titleNumber":"WK500270"},"proprietorship":{"registeredProprietors":[{"individual":{"forenames":"Sidney","surname":"Youngblood"},"addresses":[{"lineOne":"5 Cromwell Street","lineTwo":"Gloucester","lineThree":"Gloucestershire","postcode":"GL1 1RE"}]}]},"charges":[{"chargeDate":"2012-05-21","registrationDate":"2012-05-22","chargeeParties":[{"organizationName":"Abbey National PLC","address":{"lineOne":"Deeds Services","lineTwo":"101 Midsummer Boulevard","lineThree":"Milton Keynes","postcode":"MK9 1AA"}}],"additionalDetails":{"restrictionDetails":[{"chargeRestriction":{"reason":"RESTRICTION: No disposition","chargeParty":"Abbey National PLC","chargeDate":"2012-05-21"}}]}}]}}]},"summary":"List Title Documents Json Response"}},"schemas":{"CreateTitleRequest":{"required":["titleNumber"],"type":"object","properties":{"titleNumber":{"type":"string","description":"Title number format: optional 0-3 letters + 1-6 digits","example":"ABC123456"}}},"AcknowledgementResponse":{"required":["message"],"type":"object","properties":{"message":{"type":"string","example":"Request taken up for processing"}}},"LodgementApprovalsRequest":{"required":["action","approvedBy"],"type":"object","properties":{"action":{"type":"string","pattern":"^(APPROVE|UNAPPROVE)$","description":"Action to perform on lodgement applications <br> Allowed values: [`APPROVE`, `UNAPPROVE`]\n","example":"APPROVE"},"approvedBy":{"type":"string","description":"Email address of the user who performed the approval action","example":"approver@lawfirm.com"}}},"LodgementApprovalsResponse":{"required":["lodgementCaseId"],"properties":{"lodgementCaseId":{"type":"string","format":"uuid","description":"Lodgement case id for which the applications will be approved or unapproved"}}},"IndividualDetailsDto":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"RestrictionDetailsDto":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}},"OrganisationDetailsDto":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"RegisteredProprietors":{"type":"object","properties":{"registeredProprietors":{"type":"array","items":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}}}}},"RegisteredProprietor":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"TitleDocumentItem":{"type":"object","properties":{"titleDocumentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]},"fileId":{"type":"string","format":"uuid"},"documentAttributes":{"type":"object","properties":{"propertyAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}},"title":{"type":"object","properties":{"titleNumber":{"type":"string","example":"DN100"}}},"proprietorship":{"type":"object","properties":{"registeredProprietors":{"type":"array","items":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"chargeDate":{"type":"string","format":"date","example":"2021-01-30"},"registrationDate":{"type":"string","format":"date","example":"2021-01-30"},"chargeeParties":{"type":"array","items":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"additionalDetails":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}}}}}}}}},"ChargeRestrictionDto":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}},"TitleDocumentAttributesDto":{"type":"object","properties":{"propertyAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}},"title":{"type":"object","properties":{"titleNumber":{"type":"string","example":"DN100"}}},"proprietorship":{"type":"object","properties":{"registeredProprietors":{"type":"array","items":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"chargeDate":{"type":"string","format":"date","example":"2021-01-30"},"registrationDate":{"type":"string","format":"date","example":"2021-01-30"},"chargeeParties":{"type":"array","items":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"additionalDetails":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}}}}}}},"AddressDto":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}},"TitleNumberDto":{"type":"object","properties":{"titleNumber":{"type":"string","example":"DN100"}}},"ChargeePartyItem":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"ChargeDto":{"type":"object","properties":{"chargeDate":{"type":"string","format":"date","example":"2021-01-30"},"registrationDate":{"type":"string","format":"date","example":"2021-01-30"},"chargeeParties":{"type":"array","items":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"additionalDetails":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}}}},"ListTitleDocumentsResponse":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"titleDocumentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]},"fileId":{"type":"string","format":"uuid"},"documentAttributes":{"type":"object","properties":{"propertyAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}},"title":{"type":"object","properties":{"titleNumber":{"type":"string","example":"DN100"}}},"proprietorship":{"type":"object","properties":{"registeredProprietors":{"type":"array","items":{"type":"object","properties":{"individual":{"properties":{"forenames":{"type":"string","example":"Ann"},"surname":{"type":"string","example":"Smith"}}},"organisation":{"properties":{"organisationName":{"type":"string","example":"Ltd Company"},"registrationNumber":{"type":"string","example":"6473671112"},"registeredAddress":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}},"addresses":{"type":"array","items":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"chargeDate":{"type":"string","format":"date","example":"2021-01-30"},"registrationDate":{"type":"string","format":"date","example":"2021-01-30"},"chargeeParties":{"type":"array","items":{"type":"object","properties":{"organizationName":{"type":"string","example":"Ltd Company"},"address":{"properties":{"lineOne":{"type":"string","default":"","example":"Flat 3B"},"lineTwo":{"type":"string","default":"","example":"SkyView Apartments"},"lineThree":{"type":"string","default":"","example":"12, Commercial Street"},"lineFour":{"type":"string","default":"","example":"Huddersfield"},"lineFive":{"type":"string","default":"","example":"London"},"postcode":{"type":"string","default":"","example":"HD2 2WH"}}}}}},"additionalDetails":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}}}}}}}}}}}},"AdditionalDetailsDto":{"type":"object","properties":{"restrictionDetails":{"type":"array","items":{"type":"object","properties":{"chargeRestriction":{"type":"object","properties":{"reason":{"type":"string","example":"Restriction Reason"},"chargeParty":{"type":"string","example":"Charge Party"},"chargeDate":{"type":"string","format":"date","example":"2021-01-30"}}}}}}}},"TitleDocumentTypes":{"type":"string","description":"Supported document types in title","enum":["TITLE_REGISTER","TITLE_INFORMATION_DOCUMENT","EARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT"]},"FileUploadOrAttachRequest":{"required":["file","documentType","documentCategory"],"type":"object","properties":{"file":{"type":"string","format":"binary","example":"sample_document.pdf","description":"Allowed format: [`PDF`]\n"},"documentType":{"type":"string","example":"MORTGAGE_DEED","description":"Allowed values: [`MORTGAGE_DEED`,\n `TR1`,\n `RX3`,\n `BIRTH_CERTIFICATE`,\n `CORRESPONDENCE`,\n `EVIDENCE`,\n `IDENTITY_EVIDENCE`,\n `IDENTITY_FORM`,\n `MARRIAGE_CERTIFICATE`,\n `STATEMENT_OF_TRUTH`,\n `STATUTORY_DECLARATION`,\n `MORTGAGE_OFFER`,\n `REDEMPTION_STATEMENT`,\n `PG82_CERTIFICATE`,\n `COMPANIES_HOUSE_CERTIFICATE`,\n `COMPANIES_HOUSE_EVIDENCE`,\n `LAND_TRANSACTION_TAX`,\n `STAMP_DUTY_LAND_TAX`]\n"},"applicationId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"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."},"documentCategory":{"type":"string","example":"APPLICATION_DOCUMENT","description":"Allowed values: [`APPLICATION_DOCUMENT`,\n `SUPPORTING_DOCUMENT`,\n `WORKSPACE_SUPPORTING_DOCUMENT`]\n"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"}}},"FileUploadResponse":{"required":["fileId"],"properties":{"fileId":{"type":"string","format":"uuid"}}},"X-Request-Correlation-Id":{"type":"string","description":"The unique identifier for the request"},"PrimaryKeyId":{"type":"string","format":"uuid"},"CertificationTypes":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"X-API-Version":{"type":"string","description":"The API version that was used to process the request."},"Error":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://login.pexauk.co.uk/oauth/token","scopes":{"x-api:create:attachments":"Create access to the attachments","x-api:add:workspace_files":"Add access to the workspace files","view:title_documents":"View access to the title documents","x-api:view:documents":"View access to the documents","x-api:approve:lodgement_applications":"Approve access to lodgement applications","x-api:unapprove:lodgement_applications":"Unapprove access to lodgement applications","x-api:submit:lodgement_applications":"Submit access to lodgement applications","x-api:add:lodgement_titles":"Add titles to lodgementCase","view:lodgement_cases":"View lodgement cases","view:lodgement_documents":"View lodgement documents","add:lodgement_files":"Add access to the lodgement files","view:lodgement_files":"View access to the lodgement files","submit:lodgement_applications":"Submit access to the lodgement applications","view:workspaces":"View access to the workspaces"}}}}},"responses":{"ServiceUnavailable":{"description":"SERVICE UNAVAILABLE","headers":{"X-API-Version":{"schema":{"type":"string","description":"The API version that was used to process the request."}},"X-Request-Correlation-Id":{"schema":{"type":"string","description":"The unique identifier for the request"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field"},"message":{"type":"string","description":"Error message"}}}}}},"example":{"errors":[{"message":"Service under maintenance"}]}}}}}},"x-audience-url":"https://app.pexauk.co.uk/api/v1/pexa-partner"}
```