---
title: "CreateRemortgageWorkspaceRequest"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77/schemas/CreateRemortgageWorkspaceRequest"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77.md

# CreateRemortgageWorkspaceRequest

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1.3.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    CreateRemortgageWorkspaceRequest:
      type: object
      required:
        - reference
        - property
        - participants
        - parties
      properties:
        reference:
          type: string
          maxLength: 25
          minLength: 1
          example: "109344235"
        property:
          type: object
          required:
            - jurisdiction
            - securityAddress
          properties:
            jurisdiction:
              type: string
              pattern: ^(ENGLAND_WALES)$
              example: ENGLAND_WALES
              description: |
                Jurisdiction:
                 * `ENGLAND_WALES` - England/Wales
            securityAddress:
              type: object
              required:
                - postcode
              properties:
                name:
                  maxLength: 50
                  minLength: 0
                  type: string
                  example: 1 The House
                number:
                  maxLength: 4
                  minLength: 0
                  type: string
                  example: 123a
                flat:
                  maxLength: 30
                  minLength: 0
                  type: string
                  example: Flat 32
                street:
                  maxLength: 60
                  minLength: 0
                  type: string
                  example: Huddersfield
                town:
                  maxLength: 30
                  minLength: 0
                  type: string
                  example: West Yorkshire
                postcode:
                  maxLength: 8
                  minLength: 6
                  type: string
                  example: M16 0RA
                  pattern: ^(([Gg][Ii][Rr]
                    0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9][A-Za-z]?))))\s[0-9][A-Za-z]{2}))$
        parties:
          type: array
          description: >
            *minItems: 1 - Organisation borrower Party or 1 - Individual
            borrower Parties* *maxItems: 1 - Organisation borrower Party or 4 -
            Individual borrower Parties*
          items:
            oneOf:
              - type: object
                required:
                  - type
                  - partyDetails
                allOf:
                  - type: object
                    discriminator:
                      propertyName: type
                      mapping:
                        INDIVIDUAL: "#/components/schemas/RemortgageIndividualDetails"
                        ORGANISATION: "#/components/schemas/RemortgageOrganisationDetails"
                    properties:
                      role:
                        type: string
                        pattern: ^(BORROWER)$
                        description: |
                          Party Role: 
                           * `BORROWER`
                    required:
                      - role
                properties:
                  type:
                    type: string
                    pattern: (INDIVIDUAL)
                    description: |
                      Party Type:
                       * `INDIVIDUAL`
                  partyDetails:
                    type: object
                    required:
                      - forenames
                      - surname
                    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\- ']*$
              - type: object
                allOf:
                  - type: object
                    discriminator:
                      propertyName: type
                      mapping:
                        INDIVIDUAL: "#/components/schemas/RemortgageIndividualDetails"
                        ORGANISATION: "#/components/schemas/RemortgageOrganisationDetails"
                    properties:
                      role:
                        type: string
                        pattern: ^(BORROWER)$
                        description: |
                          Party Role: 
                           * `BORROWER`
                    required:
                      - role
                required:
                  - type
                  - partyDetails
                properties:
                  type:
                    type: string
                    pattern: (ORGANISATION)
                    description: |
                      Party Type:
                       * `ORGANISATION`
                  partyDetails:
                    type: object
                    required:
                      - organisationName
                      - registrationNumber
                      - organisationType
                    properties:
                      organisationName:
                        maxLength: 160
                        minLength: 1
                        type: string
                        example: My Organisation
                        pattern: ^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#‘’'(){}<>!«»“”"\[\]?*=%+\s.,:\/;\\-]+$
                      registrationNumber:
                        type: string
                        minLength: 6
                        maxLength: 8
                        pattern: ^[A-Z0-9]+$
                        example: ABCD1234
                      organisationType:
                        maxLength: 200
                        minLength: 1
                        type: string
                        pattern: ^(LIMITED_COMPANY)$
                        example: LIMITED_COMPANY
                        description: |
                          Organisation Type:
                           * `LIMITED_COMPANY`
        participants:
          type: array
          items:
            type: object
            required:
              - id
              - role
            properties:
              id:
                type: string
                format: uuid
              role:
                type: string
                pattern: ^(CONVEYANCER)
                description: |
                  Participant Role:
                   * `CONVEYANCER`
          maxItems: 1
          minItems: 1
```