Skip to main content

Documentapiv1

createdByUserKeystring

the encoded key of the user who added this document

creationDatestring

the date and time when this document was created

descriptionstring

a description of this document

documentHolderKeystring

the encoded key of the entity to which this document is attached

documentHolderTypestring

the type of entity, eg. client, loan product, to which this document is attached

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 automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472
fileSizenumber

the size, in bytes, of the attached document

idnumber

an ID for this document

lastModifiedDatestring

the date on which this document was last modified

locationstring

indicates where the document is saved

namestring

the display name of this document

originalFilenamestring

the name of the originally uploaded file

typestring

the file type of the document, eg. png, jpeg, pdf

userNamestring

the name of the user who uploaded the document

Documentapiv1
{
"createdByUserKey": "string",
"creationDate": "string",
"description": "string",
"documentHolderKey": "string",
"documentHolderType": "BRANCH",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"fileSize": 0,
"id": 0,
"lastModifiedDate": "string",
"location": "string",
"name": "string",
"originalFilename": "string",
"type": "string",
"userName": "string"
}