Skip to main content

Documentexpandedapiv1

document object

Description for document in DocumentExpandedApiV1

createdByUserKeystring

The encoded key of the user who first uploaded this document.

creationDatestring

The date on which the document was first uploaded.

descriptionstring

A description of this document.

documentHolderKeystring

The encoded key of the client, group or other entity record with which the document is associated.

documentHolderTypestring

The type of the document holder, e.g CLIENT or GROUP.

Possible values: [BRANCH, LOAN_ACCOUNT, GROUP, DEPOSIT_ACCOUNT, LINE_OF_CREDIT, LOAN_PRODUCT, GL_JOURNAL_ENTRY, SAVINGS_PRODUCT, USER, CLIENT, CENTRE, ID_DOCUMENT]

encodedKeystring

The encoded key of the uploaded document.

fileSizenumber

The size of the uploaded file.

idnumber

The user provided ID of the uploaded document.

lastModifiedDatestring

The date on which the document or its metadata was last modified.

locationstring

The encoded key used to retrieve the document from storage.

namestring

The name of the uploaded file.

originalFilenamestring

The original file name.

typestring

The file type of the uploaded file, which must be one of the supported file types.

Possible values: [JPG, JPEG, PNG, GIF, BMP, TIFF, DOC, DOCX, DOCM, DOT, DOTX, DOTM, XLS, XLSX, XLSB, PPTX, PPT, PPS, PPSX, ODT, OTT, FODT, PDF, XML, TXT, CSV, PROPERTIES, MSG, TIF, ZIP, RTF, XLSM, ODS, ODP, EML, EMLX, HTML, MHT, MHTML, XPS, NUMBERS, KEY, PAGES, YAML, JSON, JASPER, JRXML]

userNamestring

The display name of the user who first uploaded this document.

documentContentstring

Description for documentContent in DocumentExpandedApiV1

Documentexpandedapiv1
{
"document": {
"createdByUserKey": "string",
"creationDate": "string",
"description": "string",
"documentHolderKey": "string",
"documentHolderType": "BRANCH",
"encodedKey": "string",
"fileSize": 0,
"id": 0,
"lastModifiedDate": "string",
"location": "string",
"name": "string",
"originalFilename": "string",
"type": "JPG",
"userName": "string"
},
"documentContent": "string"
}