Search
K
lodgement v1

Forenames

string

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

>= 1 characters<= 90 characters

Example

Surname

string

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

>= 1 characters<= 50 characters

Example

LodgementIndividualPartyDetails

typestring

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

forenamesstring

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

>= 1 characters<= 90 characters

Example:James Thomas

surnamestring

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

>= 1 characters<= 50 characters

Example:Smith

Example

PartyItem

object
partyIdstring(uuid)read-only
typestring

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

rolestring

Allowed values: [INCOMING_LENDER, BORROWER]

Match pattern:^(INCOMING_LENDER|BORROWER)$

partyDetailsobject
Show Child Parameters
Example

Error

object
fieldstring

Field

messagestring

Error message

Example