Search
K
instruction v1

IndividualPartyDetailsDto

object
forenamesstring

Forename is required for Individual BORROWER and BUYER parties

Match pattern:^[A-Za-z][A-Za-z\- ']*$

>= 1 characters<= 90 characters

Example:James Thomas

surnamestring

Surname is required for Individual BORROWER and BUYER parties

Match pattern:^[A-Za-z][A-Za-z\ - ']*$

>= 1 characters<= 50 characters

Example:Smith

titlestring

Title (e.g., “Mr”, “Mrs”, “Dr”)

dateOfBirthstring(date)

Date of birth (YYYY-MM-DD)

mobilestring

Mobile phone number

Match pattern:^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$

>= 4 characters<= 20 characters

phonestring

Home landline phone number

Match pattern:^(\+?\d{1,4}[- ]?)?[\d\s-]{4,20}$

>= 4 characters<= 20 characters

emailstring

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

fcaNumberstring

FCA registration number is required only for Individual INTRODUCER party

Example:123456

organisationNamestring

Organization name

Match pattern:^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$

>= 1 characters<= 160 characters

Example:Mortgage Broker Corp Ltd

Example

OrganisationPartyDetailsDto

object
organisationNamestringrequired

Organization name is required for Organisation BORROWER and BUYER parties

Match pattern:^[a-zA-ZÀ-ÖØ-öø-ſĀ-ıĴ-ľŁ-ʼnŊ-ŏŐ-őŒ-žǼǺǾẀẂẄỲǽǻǿẁẃẅỳ\d&@£$€¥#'''(){}<>!«»"""\[\]?*=%+\s.,:\/;\\-]+$

>= 1 characters<= 160 characters

Example:Smith Ltd

registrationNumberstring

Company registration number is required only for Organisation BORROWER, BUYER, OUTGOING_LENDER parties

Match pattern:^[A-Z0-9]+$

>= 6 characters<= 8 characters

Example:12345678

organisationTypestring

Type of organization is required only only for Organisation BORROWER and BUYER parties Allowed Values: [LIMITED_COMPANY]

Match pattern:^(LIMITED_COMPANY)$

Example:LIMITED_COMPANY

outgoingLenderAccountNumberstring

Account number with the outgoing lender is required for only Organisation OUTGOING_LENDER party

Example:12345678

Example

CreateInstructionResponse

object
instructionIdstring(uuid)required

Unique identifier for the created instruction

workspaceIdstring(uuid)

Unique identifier for the associated PEXA workspace

partiesOne Of
array

Information about the applicants, introducer, and outgoing lender

Variant 1object
Show Child Parameters
Example

PartyResponse

object
partyIdstring(uuid)

Unique identifier for the party

rolestringrequired

Allowed Values: [BORROWER, BUYER, INTRODUCER, OUTGOING_LENDER]

Match pattern:^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$

Example

IndividualPartyResponse

object
partyIdstring(uuid)

Unique identifier for the party

rolestringrequired

Allowed Values: [BORROWER, BUYER, INTRODUCER, OUTGOING_LENDER]

Match pattern:^(BORROWER|BUYER|INTRODUCER|OUTGOING_LENDER)$

typestringrequired

Allowed Values: [INDIVIDUAL]

Match pattern:^(INDIVIDUAL)$

partyDetailsobjectrequired
Show Child Parameters
Example