Search
K
lodgement v3

DocumentItemV3

object
documentIdstring(uuid)read-only
documentTypestring

Example:MORTGAGE_DEED

documentCategorystring

Example:APPLICATION

certificationTypestring

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

fileobject
Show Child Parameters
Example

ApplicationAttributesV3

object
applicationTypestring
Example

MortgageDeedAttributesV3

object
applicationTypestring
transactionValuenumber

Example:100

landRegistryFeenumberread-only

Example:100

mortgageDeedReferencestring

Example:DN100

mortgageDeedReferenceTypestring

Allowed values:
[STANDARD, DIGITAL]

Match pattern:^(STANDARD|DIGITAL)$

Example:STANDARD

isEffectiveboolean

Example:true

signatureobject
Show Child Parameters
Example

TransferOfWholeAttributesV3

object
applicationTypestring
transactionValuenumber

Example:100

landRegistryFeenumberread-only

Example:100

considerationTypestring

Allowed values: [MONETARY_CONSIDERATION, NO_MONETARY_CONSIDERATION, TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME]

Match pattern:^(MONETARY_CONSIDERATION|NO_MONETARY_CONSIDERATION|TRANSFER_OF_MATRIMONIAL_OR_CIVIL_PARTNERSHIP_HOME)$

Example:MONETARY_CONSIDERATION

Example

CancelARestrictionAttributesV3

object
applicationTypestring
restrictionTypestring

Allowed values: [FORM_A]

Example:FORM_A

Example