Search
K
instruction v1

UpdateIndividualParty

object
partyIdstring(uuid)required

Unique identifier for the party associated with the instruction

addressesarray[object]

Address information for the party

Show Child Parameters
partyDetailsobject
Show Child Parameters
typestringrequired

Allowed Values: [INDIVIDUAL]

Match pattern:^(INDIVIDUAL)$

Example

UpdateOrganisationParty

object
partyIdstring(uuid)required

Unique identifier for the party associated with the instruction

addressesarray[object]

Address information for the party

Show Child Parameters
partyDetailsobject
Show Child Parameters
typestringrequired

Allowed Values: [ORGANISATION]

Match pattern:^(ORGANISATION)$

Example

UpdateIndividualPartyDetailsDto

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

Example

UpdateOrganisationPartyDetailsDto

object
outgoingLenderAccountNumberstring

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

Example:12345678

Example

UpdateInstructionPartyAddress

object
detailsobject
Show Child Parameters
Example