Search
K
lodgement v3

LodgementPartyRoleV3

string

Allowed values: [INCOMING_LENDER, BORROWER, PROPRIETOR, TRANSFEREE, TRANSFEROR, OUTGOING_LENDER]

Match pattern:^(INCOMING_LENDER|BORROWER|PROPRIETOR|TRANSFEREE|TRANSFEROR|OUTGOING_LENDER)$

Example

LodgementPartyDetailsV3

object
typestring

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

Example

LodgementIndividualPartyDetailsV3

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

LodgementOrganisationPartyDetailsV3

typestring

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

legalEntityNamestring

Example:Ltd Company

organisationNamestring

Example:org Company

registrationNumberstring

Example:12345

Example

X-Request-Correlation-Id

string

The unique identifier for the request