InstructionAddressDto
objectBuilding name
>= 0 characters<= 50 characters
Example:1 The House
House/building number
>= 0 characters<= 4 characters
Example:123a
Flat/apartment number
>= 0 characters<= 30 characters
Example:Flat 32
Street name
>= 0 characters<= 60 characters
Example:Huddersfield
Town/city
>= 0 characters<= 30 characters
Example:West Yorkshire
County name (required for OCE verification)
Example:Greater London
Match 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}))$
>= 6 characters<= 8 characters
Example:M16 0RA
Locality
Example:Kensington
IndividualPartyDetailsDto
objectForename is required for Individual BORROWER and BUYER parties
Match pattern:^[A-Za-z][A-Za-z\- ']*$
>= 1 characters<= 90 characters
Example:James Thomas
Surname is required for Individual BORROWER and BUYER parties
Match pattern:^[A-Za-z][A-Za-z\ - ']*$
>= 1 characters<= 50 characters
Example:Smith
Title (e.g., “Mr”, “Mrs”, “Dr”)
Date of birth (YYYY-MM-DD)
Mobile phone number
Match pattern:^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$
>= 4 characters<= 20 characters
Home landline phone number
Match pattern:^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$
>= 4 characters<= 20 characters
Email address
Match 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])+)\])
<= 100 characters
Example:john.smith@lawfirm.com
FCA registration number is required only for Individual INTRODUCER party
Example:123456
Organization name
Match pattern:^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$
>= 1 characters<= 160 characters
Example:Mortgage Broker Corp Ltd
OrganisationPartyDetailsDto
objectOrganization name is required for Organisation BORROWER and BUYER parties
Match pattern:^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$
>= 1 characters<= 160 characters
Example:Smith Ltd
Company registration number is required only for Organisation BORROWER, BUYER, OUTGOING_LENDER parties
Match pattern:^[A-Z0-9]+$
>= 6 characters<= 8 characters
Example:12345678
Type of organization is required only only for Organisation BORROWER and BUYER parties Allowed Values: [LIMITED_COMPANY]
Match pattern:^(LIMITED_COMPANY)$
Example:LIMITED_COMPANY
Account number with the outgoing lender is required for only Organisation OUTGOING_LENDER party
Example:12345678
CreateInstructionResponse
objectUnique identifier for the created instruction
Unique identifier for the associated PEXA workspace
One OfInformation about the applicants, introducer, and outgoing lender
Show Child Parameters
PartyResponse
objectUnique identifier for the party
Allowed Values: [BORROWER, BUYER, INTRODUCER, OUTGOING_LENDER]
Match pattern:^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$