Search
K
instruction v1

InstructionPartyAddress

object
typestringrequired

Allowed values: [ REGISTERED_ADDRESS]

Match pattern:^(REGISTERED_ADDRESS)$

Example:REGISTERED_ADDRESS

detailsobjectrequired
Show Child Parameters
Example

Party

object
rolestringrequired

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

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

addressesarray[object]

Address information for the party

Show Child Parameters
Example

IndividualParty

object
rolestringrequired

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

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

addressesarray[object]

Address information for the party

Show Child Parameters
typestringrequired

Allowed Values: [INDIVIDUAL]

Match pattern:^(INDIVIDUAL)$

partyDetailsobjectrequired
Show Child Parameters
Example

OrganisationParty

object
rolestringrequired

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

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

addressesarray[object]

Address information for the party

Show Child Parameters
typestringrequired

Allowed Values: [ORGANISATION]

Match pattern:^(ORGANISATION)$

partyDetailsobjectrequired
Show Child Parameters
Example

InstructionAddressDto

object
namestring

Building name

>= 0 characters<= 50 characters

Example:1 The House

numberstring

House/building number

>= 0 characters<= 4 characters

Example:123a

flatstring

Flat/apartment number

>= 0 characters<= 30 characters

Example:Flat 32

streetstring

Street name

>= 0 characters<= 60 characters

Example:Huddersfield

townstring

Town/city

>= 0 characters<= 30 characters

Example:West Yorkshire

countystring

County name (required for OCE verification)

Example:Greater London

postcodestringrequired

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

localitystring

Locality

Example:Kensington

Example