Createdocumentapiv1

a new document to be attached to an entity

document objectrequired

Description for document in CreateDocumentApiV1

documentHolderKeystringrequired

The attachment holder encoded key. eg. client key, branch key etc.

documentHolderTypestringrequired

The entity to which the document will be attached.

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

namestringrequired

The attachment file name (maximum 256 characters). Maximum one extension must be provided in the name (could be none). If the extension is provided it must match with the one provided in the type parameter. Please note: Some special characters are not allowed in the filename, these are: / < > | : & ? * [ ] # \ " '

Possible values: Value must match regular expression ^[A-Za-z0-9-_]+

typestringrequired

The attachment file extension type(example doc). Please note: Encrypted PDF files will always be rejected, since our anti-virus cannot scan them for malware.

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]

Example: PDF

descriptionstring

documentContentstringrequired

base64 encoded file

Createdocumentapiv1

{
  "document": {
    "documentHolderKey": "string",
    "documentHolderType": "CLIENT",
    "name": "string",
    "type": "PDF",
    "description": "string"
  },
  "documentContent": "string"
}