Search
K
lodgement v1

FileUploadOrAttachRequest

object
filestring(binary)required

Allowed format: [PDF]

Example:sample_document.pdf

documentTypestringrequired

Allowed values: [MORTGAGE_DEED,
BIRTH_CERTIFICATE,
CORRESPONDENCE,
EVIDENCE,
IDENTITY_EVIDENCE,
IDENTITY_FORM,
MARRIAGE_CERTIFICATE,
STATEMENT_OF_TRUTH,
STATUTORY_DECLARATION,
MORTGAGE_OFFER,
REDEMPTION_STATEMENT,
PG82_CERTIFICATE,
COMPANIES_HOUSE_CERTIFICATE,
COMPANIES_HOUSE_EVIDENCE]

Example:MORTGAGE_DEED

applicationIdstring(uuid)

To attach the uploaded document to a specific application, the corresponding Application ID must be provided. This value is not required when uploading a document to Workspace without having to attach to an application.

Example:123e4567-e89b-12d3-a456-426614174000

documentCategorystringrequired

Allowed values: [APPLICATION_DOCUMENT,
SUPPORTING_DOCUMENT,
WORKSPACE_SUPPORTING_DOCUMENT]

Example:APPLICATION_DOCUMENT

certificationTypestring

Allowed values: [CERTIFIED, ORIGINAL, SCANNED]

Match pattern:(CERTIFIED|ORIGINAL|SCANNED)

Example:CERTIFIED

Example

FileUploadResponse

fileIdstring(uuid)required
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