PartyAddressType

string

Address Type (Update Party API):

  • REGISTERED_ADDRESS - to be used when party type is ORGANISATION
  • CORRESPONDENCE_ADDRESS - to be used when party type is INDIVIDUAL

Match pattern:^(REGISTERED_ADDRESS|CORRESPONDENCE_ADDRESS)$

UpdatePartyAddress

object
typestringrequired

Address Type (Update Party API):

  • REGISTERED_ADDRESS - to be used when party type is ORGANISATION
  • CORRESPONDENCE_ADDRESS - to be used when party type is INDIVIDUAL

Match pattern:^(REGISTERED_ADDRESS|CORRESPONDENCE_ADDRESS)$

detailsobjectrequired
Show Child Parameters
Example

UpdatePartyResponse

object
partyIdstring(uuid)read-only
rolestring

Allowed values: [BORROWER, BUYER, SELLER, OUTGOING_PROPRIETOR, OUTGOING_LENDER]

Match pattern:^(BORROWER|BUYER|SELLER|OUTGOING_PROPRIETOR|OUTGOING_LENDER)$

Example:BORROWER

proprietorMatchStatusarray[string]

Allowed values: [MATCH, NAME_MISMATCH, PENDING, PROPRIETOR_NAME_CHANGE_REQUIRED, TYPE_MISMATCH, REGISTRATION_NUMBER_MISMATCH, NOT_REQUIRED, PARTY_NAME_UPDATED]

Match pattern:^(MATCH|NAME_MISMATCH|PENDING|PROPRIETOR_NAME_CHANGE_REQUIRED|TYPE_MISMATCH|REGISTRATION_NUMBER_MISMATCH|NOT_REQUIRED|PARTY_NAME_UPDATED)$

Example:NAME_MISMATCH

typestringrequired

Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

partyDetailsOne Of
Variant 1object
Show Child Parameters
representationTypestring

Allowed values: [NO_REPRESENTATION, DUAL_REPRESENTATION, SEPARATE_REPRESENTATION]

Match pattern:^(NO_REPRESENTATION|DUAL_REPRESENTATION|SEPARATE_REPRESENTATION)$

Example:NO_REPRESENTATION

representationIdstring(uuid)
representativeTypestring

Allowed values: [EXTERNAL_LAW_FIRM, PARTICIPANT]

Match pattern:^(EXTERNAL_LAW_FIRM|PARTICIPANT)$

Example:EXTERNAL_LAW_FIRM

sourceProprietorIdstring(uuid)
addressesarray[object]required
Show Child Parameters
verificationOfIdentitystring

Allowed values: [LAW_FIRM_CERTIFIED, IDENTITY_EVIDENCE]

Match pattern:^(LAW_FIRM_CERTIFIED|IDENTITY_EVIDENCE)$

Example:LAW_FIRM_CERTIFIED

Example

AddressRequest

object
namestring

>= 0 characters<= 50 characters

Example:1 The House

numberstring

>= 0 characters<= 4 characters

Example:123a

flatstring

>= 0 characters<= 30 characters

Example:Flat 32

streetstring

>= 0 characters<= 60 characters

Example:Huddersfield

townstring

>= 0 characters<= 30 characters

Example:West Yorkshire

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

Example

SecurityAddressDto

object
securityAddressIdstring(uuid)read-only

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

namestring

>= 0 characters<= 50 characters

Example:1 The House

numberstring

>= 0 characters<= 4 characters

Example:123a

flatstring

>= 0 characters<= 30 characters

Example:Flat 32

streetstring

>= 0 characters<= 60 characters

Example:Huddersfield

townstring

>= 0 characters<= 30 characters

Example:West Yorkshire

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

Example