--- title: "UpdateInstructionRequest" url: "https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac/schemas/UpdateInstructionRequest" --- > Full API specification: https://developer.pexa.co.uk/apis/instruction-v1-v1/versions/861f183b-600d-4bbf-9762-abebcbf9b5ac.md # UpdateInstructionRequest ## 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: UpdateInstructionRequest: type: object properties: loanAmount: type: number format: double minimum: 1 description: The amount of the loan property: type: object properties: unencumbered: type: boolean description: Indicates if the property is unencumbered newBuild: type: boolean description: Indicates if the property is a new build address: description: Property address. Partial address updates are discouraged. Any update will fully overwrite the existing address, so you should provide the complete address payload with every address update. type: object required: - postcode properties: flat: type: string description: Flat/apartment number name: type: string description: Building name number: type: string description: House/building number street: type: string description: Street name town: type: string description: Town/city 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}))$ locality: type: string description: Locality county: type: string description: County name parties: type: array description: Information about the applicants and outgoing lender (up to 4 applicants plus outgoing lender as needed) items: oneOf: - type: object required: - type allOf: - type: object discriminator: propertyName: type mapping: INDIVIDUAL: "#/components/schemas/UpdateIndividualParty" ORGANISATION: "#/components/schemas/UpdateOrganisationParty" properties: partyId: type: string format: uuid description: Unique identifier for the party associated with the instruction addresses: type: array items: type: object properties: details: type: object required: - postcode properties: name: maxLength: 50 minLength: 0 type: string description: Building name example: 1 The House number: maxLength: 4 minLength: 0 type: string description: House/building number example: 123a flat: maxLength: 30 minLength: 0 type: string description: Flat/apartment number example: Flat 32 street: maxLength: 60 minLength: 0 type: string description: Street name example: Huddersfield town: maxLength: 30 minLength: 0 type: string description: Town/city example: West Yorkshire locality: type: string description: Locality county: type: string description: County name (required for OCE verification) example: Greater London 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}))$ description: Address information for the party. Partial address updates are discouraged. Any update will fully overwrite the existing address, so you should provide the complete address payload with every address update. required: - partyId properties: 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 type: type: string pattern: ^(INDIVIDUAL)$ description: | Allowed Values: [`INDIVIDUAL`] - type: object required: - type allOf: - type: object discriminator: propertyName: type mapping: INDIVIDUAL: "#/components/schemas/UpdateIndividualParty" ORGANISATION: "#/components/schemas/UpdateOrganisationParty" properties: partyId: type: string format: uuid description: Unique identifier for the party associated with the instruction addresses: type: array items: type: object properties: details: type: object required: - postcode properties: name: maxLength: 50 minLength: 0 type: string description: Building name example: 1 The House number: maxLength: 4 minLength: 0 type: string description: House/building number example: 123a flat: maxLength: 30 minLength: 0 type: string description: Flat/apartment number example: Flat 32 street: maxLength: 60 minLength: 0 type: string description: Street name example: Huddersfield town: maxLength: 30 minLength: 0 type: string description: Town/city example: West Yorkshire locality: type: string description: Locality county: type: string description: County name (required for OCE verification) example: Greater London 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}))$ description: Address information for the party. Partial address updates are discouraged. Any update will fully overwrite the existing address, so you should provide the complete address payload with every address update. required: - partyId properties: partyDetails: type: object properties: outgoingLenderAccountNumber: type: string description: Account number with the outgoing lender is required for only Organisation OUTGOING_LENDER party example: "12345678" type: type: string pattern: ^(ORGANISATION)$ description: | Allowed Values: [`ORGANISATION`] mortgagePrisoner: type: boolean description: Indicates if this is a mortgage prisoner ```