Search
K
lodgement v3

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

X-API-Version

string

The API version that was used to process the request.

AuditAttributes

object
createdAtstring(date-time)
createdBystring
lastModifiedAtstring(date-time)
lastModifiedBystring
Example