---
title: "LodgementCaseItemV3"
url: "https://developer.pexa.co.uk/apis/lodgement-v3-v3/versions/76a0e091-298f-40ba-831d-4caf29f8dbe9/schemas/LodgementCaseItemV3"
---

> Full API specification: https://developer.pexa.co.uk/apis/lodgement-v3-v3/versions/76a0e091-298f-40ba-831d-4caf29f8dbe9.md

# LodgementCaseItemV3

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lodgement
  version: v3.2.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    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`]
        workspaceId:
          type: string
          format: uuid
        workspaceReferenceId:
          type: string
        lastTitleSearchStatus:
          type: string
          pattern: ^(INITIATED|PENDING|SUCCESS|FAILED)$
          description: |
            Allowed values: [`INITIATED`, `PENDING`, `SUCCESS`, `FAILED`]
        transactionType:
          type: string
          pattern: ^(PURCHASE|REMORTGAGE)$
          description: |
            Allowed values: [`PURCHASE`, `REMORTGAGE`]
        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`]
                    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`]
                        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:
                            [`STANDARD`, `DIGITAL`]
                      isEffective:
                        type: boolean
                        example: true
                      signature:
                        type: object
                        required:
                          - format
                          - type
                        properties:
                          format:
                            type: string
                            pattern: ^(MANUAL|ELECTRONIC)$
                            description: |
                              Allowed values: [`MANUAL`, `ELECTRONIC`]
                          type:
                            type: string
                            pattern: ^(WET_INK_SIGNATURE|CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE|ADVANCED_ELECTRONIC_SIGNATURE|QUALIFIED_ELECTRONIC_SIGNATURE)$
                            description: >
                              Allowed values: [`WET_INK_SIGNATURE`,
                              `CONVEYANCER_CERTIFIED_ELECTRONIC_SIGNATURE`,
                              `ADVANCED_ELECTRONIC_SIGNATURE`,
                              `QUALIFIED_ELECTRONIC_SIGNATURE`]
                      signingDetails:
                        type: object
                        required:
                          - status
                        properties:
                          signingInstructionId:
                            type: string
                            format: uuid
                            description: Identifier of the signing instruction.
                          signingDocumentId:
                            type: string
                            format: uuid
                            description: Identifier of the signing document.
                          status:
                            type: string
                            description: Status of the signing artefact.
                  - 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|OTHER)$
                        description: >
                          Allowed values: [`MONETARY_CONSIDERATION`,
                          `NO_MONETARY_CONSIDERATION`, `OTHER`]
                        example: MONETARY_CONSIDERATION
                      considerationAmount:
                        type: number
                        description: Consideration amount for the transfer
                      considerationDetails:
                        type: string
                        description: Free-text consideration details
                      titleGuarantee:
                        type: string
                        pattern: ^(FULL|LIMITED)$
                        description: Title guarantee class
                      executionParties:
                        type: string
                        pattern: ^(TRANSFEROR|TRANSFEROR_AND_TRANSFEREE)$
                        description: Determines who signs the TR1 form
                      declarationOfTrust:
                        type: object
                        properties:
                          type:
                            type: string
                            pattern: ^(JOINT_TENANTS|TENANTS_IN_COMMON|TRUST_DETAILS)$
                            example: TRUST_DETAILS
                            description: >
                              Allowed values:  [`JOINT_TENANTS`,
                              `TENANTS_IN_COMMON`, `TRUST_DETAILS`]
                          details:
                            type: string
                            maxLength: 300
                            description: Required when `type` is `TRUST_DETAILS`.
                      additionalProvisions:
                        type: object
                        properties:
                          code:
                            type: string
                            pattern: ^(NO_PROVISIONS|DETAILS_ENTERED)$
                            example: DETAILS_ENTERED
                            description: >
                              Allowed values:  [`NO_PROVISIONS`,
                              `DETAILS_ENTERED`]
                          details:
                            type: string
                            maxLength: 4000
                            description: Required when `code` is `DETAILS_ENTERED`.
                      transferOfWholePartyAttributes:
                        type: array
                        items:
                          type: object
                          required:
                            - proprietorId
                          properties:
                            proprietorId:
                              type: string
                              format: uuid
                              example: 587ed2aa-ee40-4589-841e-0f990e37a2b6
                            addresses:
                              type: array
                              items:
                                type: object
                                properties:
                                  addressType:
                                    type: string
                                    pattern: ^(PROPERTY_ADDRESS|CORRESPONDENCE_ADDRESS|REGISTERED_ADDRESS)$
                                    example: PROPERTY_ADDRESS
                                    description: >
                                      Allowed values:  [`PROPERTY_ADDRESS`,
                                      `CORRESPONDENCE_ADDRESS`,
                                      `REGISTERED_ADDRESS`]
                                  addressId:
                                    type: string
                                    format: uuid
                                    example: 587ed2aa-ee40-4589-841e-0f990e37a2b6
                            signingArrangement:
                              type: string
                              pattern: ^(TWO_DIRECTORS|DIRECTOR_AND_COMPANY_SECRETARY|ONE_DIRECTOR_WITH_WITNESS|COMPANY_SEAL)$
                              example: TWO_DIRECTORS
                              description: >
                                Allowed values: [ `TWO_DIRECTORS`,
                                `DIRECTOR_AND_COMPANY_SECRETARY`,
                                `ONE_DIRECTOR_WITH_WITNESS`, `COMPANY_SEAL` ]
                  - 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`]
                  - 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`]
                    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`]
                        example: "[BORROWER]"
                    partyDetails:
                      type: object
                      properties:
                        type:
                          type: string
                          pattern: ^(INDIVIDUAL|ORGANISATION)$
                          example: INDIVIDUAL
                          description: |
                            Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
                      discriminator:
                        propertyName: type
                        mapping:
                          INDIVIDUAL: "#/components/schemas/LodgementIndividualPartyDetailsV3"
                          ORGANISATION: "#/components/schemas/LodgementOrganisationPartyDetailsV3"
                    addresses:
                      type: array
                      description: Party addresses — CORRESPONDENCE_ADDRESS for individuals,
                        REGISTERED_ADDRESS for organisations
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            pattern: (CORRESPONDENCE_ADDRESS|REGISTERED_ADDRESS)
                          details:
                            type: object
                            properties:
                              addressId:
                                type: string
                                format: uuid
                              name:
                                type: string
                              number:
                                type: string
                              flat:
                                type: string
                              street:
                                type: string
                              town:
                                type: string
                              postcode:
                                type: string
              applicationParties:
                type: array
                items:
                  oneOf:
                    - allOf:
                        - type: object
                          properties:
                            applicationPartyType:
                              type: string
                            applicationPartyRole:
                              type: string
                              pattern: ^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$
                              description: >
                                Allowed values: [`INCOMING_LENDER`, `BORROWER`,
                                `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`,
                                `OUTGOING_LENDER`]
                              example: "[BORROWER]"
                          discriminator:
                            propertyName: applicationPartyType
                            mapping:
                              PROPRIETOR: "#/components/schemas/ProprietorApplicationPartyItemV3"
                              PARTICIPANT: "#/components/schemas/ParticipantApplicationPartyItemV3"
                              PARTY: "#/components/schemas/PartyApplicationPartyItemV3"
                        - type: object
                          properties:
                            proprietorId:
                              type: string
                              format: uuid
                            registeredProprietorId:
                              type: string
                              format: uuid
                            partyId:
                              type: string
                              format: uuid
                            proprietorType:
                              type: string
                            titleStatus:
                              type: string
                            auditAttributes:
                              type: object
                              properties:
                                createdAt:
                                  type: string
                                  format: date-time
                                createdBy:
                                  type: string
                                lastModifiedAt:
                                  type: string
                                  format: date-time
                                lastModifiedBy:
                                  type: string
                            individualDetails:
                              allOf:
                                - type: object
                                  properties:
                                    type:
                                      type: string
                                      pattern: ^(INDIVIDUAL|ORGANISATION)$
                                      example: INDIVIDUAL
                                      description: >
                                        Allowed values: [`INDIVIDUAL`,
                                        `ORGANISATION`]
                                  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\- ']*$
                            organisationDetails:
                              allOf:
                                - type: object
                                  properties:
                                    type:
                                      type: string
                                      pattern: ^(INDIVIDUAL|ORGANISATION)$
                                      example: INDIVIDUAL
                                      description: >
                                        Allowed values: [`INDIVIDUAL`,
                                        `ORGANISATION`]
                                  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"
                            addresses:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    pattern: (CORRESPONDENCE_ADDRESS|REGISTERED_ADDRESS)
                                  details:
                                    type: object
                                    properties:
                                      addressId:
                                        type: string
                                        format: uuid
                                      name:
                                        type: string
                                      number:
                                        type: string
                                      flat:
                                        type: string
                                      street:
                                        type: string
                                      town:
                                        type: string
                                      postcode:
                                        type: string
                    - allOf:
                        - type: object
                          properties:
                            applicationPartyType:
                              type: string
                            applicationPartyRole:
                              type: string
                              pattern: ^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$
                              description: >
                                Allowed values: [`INCOMING_LENDER`, `BORROWER`,
                                `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`,
                                `OUTGOING_LENDER`]
                              example: "[BORROWER]"
                          discriminator:
                            propertyName: applicationPartyType
                            mapping:
                              PROPRIETOR: "#/components/schemas/ProprietorApplicationPartyItemV3"
                              PARTICIPANT: "#/components/schemas/ParticipantApplicationPartyItemV3"
                              PARTY: "#/components/schemas/PartyApplicationPartyItemV3"
                        - type: object
                          properties:
                            participantId:
                              type: string
                              format: uuid
                            legalEntityName:
                              type: string
                            subscriberId:
                              type: string
                              format: uuid
                            participantRole:
                              type: string
                            auditAttributes:
                              type: object
                              properties:
                                createdAt:
                                  type: string
                                  format: date-time
                                createdBy:
                                  type: string
                                lastModifiedAt:
                                  type: string
                                  format: date-time
                                lastModifiedBy:
                                  type: string
                    - allOf:
                        - type: object
                          properties:
                            applicationPartyType:
                              type: string
                            applicationPartyRole:
                              type: string
                              pattern: ^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$
                              description: >
                                Allowed values: [`INCOMING_LENDER`, `BORROWER`,
                                `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`,
                                `OUTGOING_LENDER`]
                              example: "[BORROWER]"
                          discriminator:
                            propertyName: applicationPartyType
                            mapping:
                              PROPRIETOR: "#/components/schemas/ProprietorApplicationPartyItemV3"
                              PARTICIPANT: "#/components/schemas/ParticipantApplicationPartyItemV3"
                              PARTY: "#/components/schemas/PartyApplicationPartyItemV3"
                        - type: object
                          properties:
                            partyId:
                              type: string
                              format: uuid
                            type:
                              type: string
                              pattern: ^(INDIVIDUAL|ORGANISATION)$
                              example: INDIVIDUAL
                              description: |
                                Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
                            role:
                              type: string
                              pattern: ^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$
                              description: >
                                Allowed values: [`INCOMING_LENDER`, `BORROWER`,
                                `PROPRIETOR`, `TRANSFEREE`, `TRANSFEROR`,
                                `OUTGOING_LENDER`]
                              example: "[BORROWER]"
                            auditAttributes:
                              type: object
                              properties:
                                createdAt:
                                  type: string
                                  format: date-time
                                createdBy:
                                  type: string
                                lastModifiedAt:
                                  type: string
                                  format: date-time
                                lastModifiedBy:
                                  type: string
                            partyDetails:
                              type: object
                              properties:
                                type:
                                  type: string
                                  pattern: ^(INDIVIDUAL|ORGANISATION)$
                                  example: INDIVIDUAL
                                  description: >
                                    Allowed values: [`INDIVIDUAL`,
                                    `ORGANISATION`]
                              discriminator:
                                propertyName: type
                                mapping:
                                  INDIVIDUAL: "#/components/schemas/LodgementIndividualPartyDetailsV3"
                                  ORGANISATION: "#/components/schemas/LodgementOrganisationPartyDetailsV3"
                            addresses:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    pattern: (CORRESPONDENCE_ADDRESS|REGISTERED_ADDRESS)
                                  details:
                                    type: object
                                    properties:
                                      addressId:
                                        type: string
                                        format: uuid
                                      name:
                                        type: string
                                      number:
                                        type: string
                                      flat:
                                        type: string
                                      street:
                                        type: string
                                      town:
                                        type: string
                                      postcode:
                                        type: string
        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
```
