Search
K
instruction v1

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

OrganisationPartyResponse

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: [ORGANISATION]

Match pattern:^(ORGANISATION)$

partyDetailsobjectrequired
Show Child Parameters
Example