---
title: "CreateInstructionResponse"
url: "https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac/schemas/CreateInstructionResponse"
---

> Full API specification: https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac.md

# CreateInstructionResponse

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Lender Instruction
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    CreateInstructionResponse:
      type: object
      required:
        - instructionId
      properties:
        instructionId:
          type: string
          format: uuid
          description: Unique identifier for the created instruction
        workspaceId:
          type: string
          format: uuid
          description: Unique identifier for the associated PEXA workspace
        parties:
          type: array
          description: Information about the applicants, introducer, and outgoing lender
          items:
            oneOf:
              - type: object
                required:
                  - type
                  - partyDetails
                allOf:
                  - type: object
                    discriminator:
                      propertyName: type
                      mapping:
                        INDIVIDUAL: "#/components/schemas/IndividualPartyResponse"
                        ORGANISATION: "#/components/schemas/OrganisationPartyResponse"
                    properties:
                      partyId:
                        type: string
                        format: uuid
                        description: Unique identifier for the party
                      role:
                        type: string
                        pattern: ^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$
                        description: >
                          Allowed Values: [`BORROWER`, `BUYER`, `INTRODUCER`,
                          `OUTGOING_LENDER`]
                    required:
                      - role
                properties:
                  type:
                    type: string
                    pattern: ^(INDIVIDUAL)$
                    description: |
                      Allowed Values: [`INDIVIDUAL`]
                  partyDetails:
                    type: object
                    properties:
                      forenames:
                        type: string
                        maxLength: 90
                        minLength: 1
                        pattern: ^[A-Za-z][A-Za-z\- ']*$
                        description: Forename is required for Individual BORROWER and BUYER parties
                        example: James Thomas
                      surname:
                        type: string
                        maxLength: 50
                        minLength: 1
                        pattern: ^[A-Za-z][A-Za-z\ - ']*$
                        description: Surname is required for Individual BORROWER and BUYER parties
                        example: Smith
                      title:
                        type: string
                        description: Title (e.g., "Mr", "Mrs", "Dr")
                      dateOfBirth:
                        type: string
                        format: date
                        description: Date of birth (YYYY-MM-DD)
                      mobile:
                        type: string
                        pattern: ^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$
                        description: Mobile phone number
                        minLength: 4
                        maxLength: 20
                      phone:
                        type: string
                        pattern: ^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$
                        description: Home landline phone number
                        minLength: 4
                        maxLength: 20
                      email:
                        type: string
                        maxLength: 100
                        pattern: ^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
                        example: john.smith@lawfirm.com
                        description: Email address
                      fcaNumber:
                        type: string
                        description: FCA registration number is required only for Individual INTRODUCER
                          party
                        example: "123456"
                      organisationName:
                        type: string
                        maxLength: 160
                        minLength: 1
                        pattern: ^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$
                        description: Organization name
                        example: Mortgage Broker Corp Ltd
              - type: object
                required:
                  - type
                  - partyDetails
                allOf:
                  - type: object
                    discriminator:
                      propertyName: type
                      mapping:
                        INDIVIDUAL: "#/components/schemas/IndividualPartyResponse"
                        ORGANISATION: "#/components/schemas/OrganisationPartyResponse"
                    properties:
                      partyId:
                        type: string
                        format: uuid
                        description: Unique identifier for the party
                      role:
                        type: string
                        pattern: ^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$
                        description: >
                          Allowed Values: [`BORROWER`, `BUYER`, `INTRODUCER`,
                          `OUTGOING_LENDER`]
                    required:
                      - role
                properties:
                  type:
                    type: string
                    pattern: ^(ORGANISATION)$
                    description: |
                      Allowed Values: [`ORGANISATION`]
                  partyDetails:
                    type: object
                    required:
                      - organisationName
                    properties:
                      organisationName:
                        type: string
                        maxLength: 160
                        minLength: 1
                        pattern: ^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$
                        description: Organization name is required for Organisation BORROWER and BUYER
                          parties
                        example: Smith Ltd
                      registrationNumber:
                        type: string
                        minLength: 6
                        maxLength: 8
                        pattern: ^[A-Z0-9]+$
                        description: Company registration number is required only for Organisation
                          BORROWER, BUYER, OUTGOING_LENDER parties
                        example: "12345678"
                      organisationType:
                        type: string
                        pattern: ^(LIMITED_COMPANY)$
                        description: >
                          Type of organization is required only only for
                          Organisation BORROWER and BUYER parties Allowed
                          Values: [`LIMITED_COMPANY`]
                        example: LIMITED_COMPANY
                      outgoingLenderAccountNumber:
                        type: string
                        description: Account number with the outgoing lender is required for only
                          Organisation OUTGOING_LENDER party
                        example: "12345678"
```