---
title: "Lodgement"
url: "https://developer.pexa.co.uk/apis/lodgement-v3-v3/versions/36a70223-1b6a-4258-8121-37db0f9b4edb"
---

# 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":"v3.0.0","x-api-version":"3.0.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/v3/lodgement-cases":{"get":{"tags":["LodgementCaseV3"],"summary":"Lodgement Case Summary V3","description":"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.","security":[{"oauth2":["x-api:view:lodgement_summary","view:lodgement_cases","view:lodgement_documents","view:lodgement_titles"]}],"operationId":"getLodgementCaseSummaryV3","parameters":[{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}},{"in":"query","name":"workspace_id","description":"workspace-id","required":true,"schema":{"type":"string","format":"uuid"}}],"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":{"required":["lodgementCaseId","lodgementCaseStatus"],"type":"object","properties":{"lodgementCaseId":{"type":"string","format":"uuid"},"lodgementCaseStatus":{"readOnly":true,"type":"string","pattern":"^(CREATED|PREPARED|INITIATED|LODGED|REGISTERED|REQUISITIONED|REQUISITION_SUBMITTED|PARTIALLY_REGISTERED|REGISTRATION_REJECTED|REGISTERED_EXTERNALLY|RESUBMISSION_PREPARED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `INITIATED`, `LODGED`, `REGISTERED`, `REQUISITIONED`, `REQUISITION_SUBMITTED`, `PARTIALLY_REGISTERED`, `REGISTRATION_REJECTED`, `REGISTERED_EXTERNALLY`, `RESUBMISSION_PREPARED`]\n"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string"},"lastTitleSearchStatus":{"type":"string","pattern":"^(INITIATED|PENDING|SUCCESS|FAILED)$","description":"Allowed values: [`INITIATED`, `PENDING`, `SUCCESS`, `FAILED`]\n"},"transactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"applications":{"type":"array","items":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","readOnly":true},"applicationType":{"type":"string","example":"MORTGAGE_DEED"},"status":{"readOnly":true,"type":"string"},"submittedAt":{"type":"string","format":"date-time"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","example":"MORTGAGE_DEED"},"documentCategory":{"type":"string","example":"APPLICATION"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"file":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}}}}},"attributes":{"oneOf":[{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"mortgageDeedReference":{"type":"string","example":"DN100"},"mortgageDeedReferenceType":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"isEffective":{"type":"boolean","example":true},"signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"considerationType":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"restrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"chargeIdentifier":{"type":"string"}}}]},"parties":{"type":"array","items":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"role":{"type":"array","items":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"}},"partyDetails":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}}}}}}}},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"titles":{"type":"array","items":{"required":["titleId","titleNumber"],"type":"object","properties":{"titleId":{"type":"string","format":"uuid"},"titleNumber":{"type":"string","example":"DN100"},"initialEditionDate":{"type":"string","format":"date","example":"2024-01-15"}}}}}}}}}}}},"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"}]}}}}}}}},"components":{"schemas":{"LodgementSummaryResponseV3":{"type":"object","properties":{"records":{"type":"array","items":{"required":["lodgementCaseId","lodgementCaseStatus"],"type":"object","properties":{"lodgementCaseId":{"type":"string","format":"uuid"},"lodgementCaseStatus":{"readOnly":true,"type":"string","pattern":"^(CREATED|PREPARED|INITIATED|LODGED|REGISTERED|REQUISITIONED|REQUISITION_SUBMITTED|PARTIALLY_REGISTERED|REGISTRATION_REJECTED|REGISTERED_EXTERNALLY|RESUBMISSION_PREPARED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `INITIATED`, `LODGED`, `REGISTERED`, `REQUISITIONED`, `REQUISITION_SUBMITTED`, `PARTIALLY_REGISTERED`, `REGISTRATION_REJECTED`, `REGISTERED_EXTERNALLY`, `RESUBMISSION_PREPARED`]\n"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string"},"lastTitleSearchStatus":{"type":"string","pattern":"^(INITIATED|PENDING|SUCCESS|FAILED)$","description":"Allowed values: [`INITIATED`, `PENDING`, `SUCCESS`, `FAILED`]\n"},"transactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"applications":{"type":"array","items":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","readOnly":true},"applicationType":{"type":"string","example":"MORTGAGE_DEED"},"status":{"readOnly":true,"type":"string"},"submittedAt":{"type":"string","format":"date-time"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","example":"MORTGAGE_DEED"},"documentCategory":{"type":"string","example":"APPLICATION"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"file":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}}}}},"attributes":{"oneOf":[{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"mortgageDeedReference":{"type":"string","example":"DN100"},"mortgageDeedReferenceType":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"isEffective":{"type":"boolean","example":true},"signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"considerationType":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"restrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"chargeIdentifier":{"type":"string"}}}]},"parties":{"type":"array","items":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"role":{"type":"array","items":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"}},"partyDetails":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}}}}}}}},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"titles":{"type":"array","items":{"required":["titleId","titleNumber"],"type":"object","properties":{"titleId":{"type":"string","format":"uuid"},"titleNumber":{"type":"string","example":"DN100"},"initialEditionDate":{"type":"string","format":"date","example":"2024-01-15"}}}}}}}}},"LodgementCaseItemV3":{"required":["lodgementCaseId","lodgementCaseStatus"],"type":"object","properties":{"lodgementCaseId":{"type":"string","format":"uuid"},"lodgementCaseStatus":{"readOnly":true,"type":"string","pattern":"^(CREATED|PREPARED|INITIATED|LODGED|REGISTERED|REQUISITIONED|REQUISITION_SUBMITTED|PARTIALLY_REGISTERED|REGISTRATION_REJECTED|REGISTERED_EXTERNALLY|RESUBMISSION_PREPARED)$","description":"Allowed values: [`CREATED`, `PREPARED`, `INITIATED`, `LODGED`, `REGISTERED`, `REQUISITIONED`, `REQUISITION_SUBMITTED`, `PARTIALLY_REGISTERED`, `REGISTRATION_REJECTED`, `REGISTERED_EXTERNALLY`, `RESUBMISSION_PREPARED`]\n"},"workspaceId":{"type":"string","format":"uuid"},"workspaceReferenceId":{"type":"string"},"lastTitleSearchStatus":{"type":"string","pattern":"^(INITIATED|PENDING|SUCCESS|FAILED)$","description":"Allowed values: [`INITIATED`, `PENDING`, `SUCCESS`, `FAILED`]\n"},"transactionType":{"type":"string","pattern":"^(PURCHASE|REMORTGAGE)$","description":"Allowed values: [`PURCHASE`, `REMORTGAGE`]\n"},"applications":{"type":"array","items":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","readOnly":true},"applicationType":{"type":"string","example":"MORTGAGE_DEED"},"status":{"readOnly":true,"type":"string"},"submittedAt":{"type":"string","format":"date-time"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","example":"MORTGAGE_DEED"},"documentCategory":{"type":"string","example":"APPLICATION"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"file":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}}}}},"attributes":{"oneOf":[{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"mortgageDeedReference":{"type":"string","example":"DN100"},"mortgageDeedReferenceType":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"isEffective":{"type":"boolean","example":true},"signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"considerationType":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"restrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"chargeIdentifier":{"type":"string"}}}]},"parties":{"type":"array","items":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"role":{"type":"array","items":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"}},"partyDetails":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}}}}}}}},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"titles":{"type":"array","items":{"required":["titleId","titleNumber"],"type":"object","properties":{"titleId":{"type":"string","format":"uuid"},"titleNumber":{"type":"string","example":"DN100"},"initialEditionDate":{"type":"string","format":"date","example":"2024-01-15"}}}}}},"LodgementApplicationItemV3":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","readOnly":true},"applicationType":{"type":"string","example":"MORTGAGE_DEED"},"status":{"readOnly":true,"type":"string"},"submittedAt":{"type":"string","format":"date-time"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","example":"MORTGAGE_DEED"},"documentCategory":{"type":"string","example":"APPLICATION"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"file":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}}}}},"attributes":{"oneOf":[{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"mortgageDeedReference":{"type":"string","example":"DN100"},"mortgageDeedReferenceType":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"isEffective":{"type":"boolean","example":true},"signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"considerationType":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"restrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"}}},{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"chargeIdentifier":{"type":"string"}}}]},"parties":{"type":"array","items":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"role":{"type":"array","items":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"}},"partyDetails":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}}}}}}},"DocumentItemV3":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","readOnly":true},"documentType":{"type":"string","example":"MORTGAGE_DEED"},"documentCategory":{"type":"string","example":"APPLICATION"},"certificationType":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"file":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}}}},"ApplicationAttributesV3":{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},"MortgageDeedAttributesV3":{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"mortgageDeedReference":{"type":"string","example":"DN100"},"mortgageDeedReferenceType":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"isEffective":{"type":"boolean","example":true},"signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}}}},"TransferOfWholeAttributesV3":{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"transactionValue":{"type":"number","example":100},"landRegistryFee":{"type":"number","example":100,"readOnly":true},"considerationType":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"}}},"CancelARestrictionAttributesV3":{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"restrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"}}},"DischargeAttributesV3":{"allOf":[{"type":"object","properties":{"applicationType":{"type":"string"}},"discriminator":{"propertyName":"applicationType","mapping":{"MORTGAGE_DEED":"#/components/schemas/MortgageDeedAttributesV3","TRANSFER_OF_WHOLE":"#/components/schemas/TransferOfWholeAttributesV3","CANCEL_A_RESTRICTION":"#/components/schemas/CancelARestrictionAttributesV3","DISCHARGE":"#/components/schemas/DischargeAttributesV3"}}},{"type":"object"}],"type":"object","properties":{"chargeIdentifier":{"type":"string"}}},"PartyItemV3":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","readOnly":true},"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"role":{"type":"array","items":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"}},"partyDetails":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}}}},"LodgementPartyRoleV3":{"type":"string","pattern":"^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$","description":"Allowed values: [`INCOMING_LENDER`, `BORROWER`, `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`, `OUTGOING_LENDER`]\n","example":"[BORROWER]"},"LodgementPartyDetailsV3":{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}},"LodgementIndividualPartyDetailsV3":{"allOf":[{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}},{"type":"object","properties":{"forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"}}}]},"LodgementOrganisationPartyDetailsV3":{"allOf":[{"type":"object","properties":{"type":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"}},"discriminator":{"propertyName":"type","mapping":{"INDIVIDUAL":"#/components/schemas/LodgementIndividualPartyDetailsV3","ORGANISATION":"#/components/schemas/LodgementOrganisationPartyDetailsV3"}}},{"type":"object","properties":{"legalEntityName":{"type":"string","example":"Ltd Company"},"organisationName":{"type":"string","example":"org Company"},"registrationNumber":{"type":"string","example":"12345"}}}]},"X-Request-Correlation-Id":{"type":"string","description":"The unique identifier for the request"},"X-API-Version":{"type":"string","description":"The API version that was used to process the request."},"AuditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"CertificationTypes":{"type":"string","pattern":"(CERTIFIED|ORIGINAL|SCANNED)","example":"CERTIFIED","description":"Allowed values: [`CERTIFIED`, `ORIGINAL`, `SCANNED`]\n"},"FileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"FileItem":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid","readOnly":true},"fileName":{"type":"string","example":"sample_document.pdf"},"fileUploadStatus":{"type":"string","pattern":"(SUCCESS|PENDING|VIRUS_FOUND|FAILED)","example":"SUCCESS","description":"Allowed values: [`SUCCESS`, `PENDING`, `VIRUS_FOUND`, `FAILED`]\n"},"auditAttributes":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}}}},"ConsiderationTypes":{"type":"string","pattern":"^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$","description":"Allowed values: [`MONETARY_CONSIDERATION`, `NO_MONETARY_CONSIDERATION`, `TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME`]\n","example":"MONETARY_CONSIDERATION"},"RestrictionType":{"type":"string","example":"FORM_A","description":"Allowed values: [`FORM_A`]\n"},"ChargeIdentifier":{"type":"string"},"MortgageDeedReferenceTypesV2":{"type":"string","pattern":"^(STANDARD|DIGITAL)$","example":"STANDARD","description":"Allowed values:\n  [`STANDARD`, `DIGITAL`]\n"},"Signature":{"type":"object","required":["format","type"],"properties":{"format":{"type":"string","pattern":"^(MANUAL|ELECTRONIC)$"},"type":{"type":"string","pattern":"^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE)$"}}},"PartyType":{"type":"string","pattern":"^(INDIVIDUAL|ORGANISATION)$","example":"INDIVIDUAL","description":"Allowed values: [`INDIVIDUAL`, `ORGANISATION`]\n"},"Forenames":{"maxLength":90,"minLength":1,"type":"string","example":"James Thomas","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"Surname":{"maxLength":50,"minLength":1,"type":"string","example":"Smith","pattern":"^[A-Za-z][A-Za-z\\- ']*$"},"TitleItemV2":{"required":["titleId","titleNumber"],"type":"object","properties":{"titleId":{"type":"string","format":"uuid"},"titleNumber":{"type":"string","example":"DN100"},"initialEditionDate":{"type":"string","format":"date","example":"2024-01-15"}}},"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:view:lodgement_summary":"View lodgement summary","view:lodgement_cases":"View lodgement cases","view:lodgement_documents":"View lodgement documents","view:lodgement_titles":"View lodgement titles"}}}}},"parameters":{"X-Request-Correlation-Id":{"in":"header","name":"X-Request-Correlation-Id","schema":{"type":"string","description":"The unique identifier for the request"}}},"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"}
```