Documentforaccountapiv1

encodedKeystring

The encoded key of the uploaded document.

idstring

The user provided ID of the uploaded document.

creationDatestring

The date on which the document was first uploaded.

lastModifiedDatestring

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

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, eg 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]

namestring

The name of the original uploaded file.

typestring

The file type of the uploaded file, 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]

fileSizestring

The size of the uploaded file.

originalFilenamestring

The original file name.

locationstring

The encoded key used to retrieve the document from storage.

descriptionstring

The description of this document provided at the time of upload.

createdByUserKeystring

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

userNamestring

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

documentHolder object

Description for documentHolder in DocumentForAccountApiV1

typestring

The type of account that the document belongs to.

Possible values: [LOAN, SAVINGS]

Example: LOAN

holderkeystring

The encoded key of the document owner.

Example: 8a193c262f3b51b701722d77c5e423b7

accountHolderTypestring

The type of entity that owns the document.

Possible values: [CLIENT, GROUP]

Example: CLIENT

encodedKeystring

The encoded key of the account to which the document relates.

Example: 8a19b6e4746cc6abf1746cf1436c00c5

displayNamestring

The ID of the account to which the document relates.

Example: ABC111

Documentforaccountapiv1

{
  "encodedKey": "string",
  "id": "string",
  "creationDate": "string",
  "lastModifiedDate": "string",
  "documentHolderKey": "string",
  "documentHolderType": "BRANCH",
  "name": "string",
  "type": "JPG",
  "fileSize": "string",
  "originalFilename": "string",
  "location": "string",
  "description": "string",
  "createdByUserKey": "string",
  "userName": "string",
  "documentHolder": {
    "type": "LOAN",
    "holderkey": "8a193c262f3b51b701722d77c5e423b7",
    "accountHolderType": "CLIENT",
    "encodedKey": "8a19b6e4746cc6abf1746cf1436c00c5",
    "displayName": "ABC111"
  }
}