Please visit our Help Center for API key setup instructions, etc.

Download Document

Headers:

Name	Type	Description
x-api-key	string	Your x-api-key

Arguments:

Name	Type	Description
attachmentId	string	id of attachment (document)

Response:

Document itself

Upload Documents

Headers:

Name	Type	Description
x-api-key	string	Your x-api-key
Content-Type	string	multipart/form-data

Arguments:

Name	Type	Description
recordId	string	id of person or entity
recordType	string	must be 'person' or 'entity'
file	File	file itself
isMinuteBookUpload	boolean	uploads the file to minute book (available only for entity)

Important validation cases

• recordId and recordType are required.
• the id has to be valid
• the person/entity has to exist
• the api key has to have access to the person/entity
• the request body has to have at least one file
• the request body can’t have more that 20 file
• the files can’t be more that 50 MB
• the files have to have the same type as the ones allowed by MIME types

MIME types, that allowed for uploading documents:

• application/msword,
• application/vnd.openxmlformats-officedocument.wordprocessingml.document,
• application/vnd.ms-word.document.macroenabled.12,
• application/vnd.oasis.opendocument.text,
• application/octet-stream,
• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
• application/vnd.openxmlformats-officedocument.presentationml.presentation,
• image/png,
• image/jpeg,
• application/xml,
• application/pdf

Responses:

All documents are fine:

{
    "documents": [
        {
            "name": "myDocument",
            "createdDate": "2024-01-01T00:00:00.000Z",
            "fileType": "pdf",
            "attachmentId": "123abc"
        }
    ],
    "type": "OK"
}

Example, when 1 or more documents are failed:

{
    "documents": [
        {
            "name": "myDocument",
            "createdDate": "2024-01-01T00:00:00.000Z",
            "fileType": "pdf",
            "attachmentId": "123abc"
        }
    ],
    "errors": [
        {
            "err": "Error processing fields from \"myDocument-2\"",
            "msg": "ERROR - Detecting PDF fields",
            "status": 400
        }
    ],
    "type": "OK"
}

Example, when upload is failed:

{
    "type": "ERR",
    "msg": "ERROR - Document could not be uploaded",
    "err": "No files provided",
    "errCode": 400
}

Example, when file is too big:

{
    "documents": [],
    "errors": [
        {
            "message": "File myDocument.pdf exceeds filesize limit of 50 MB",
            "status": 400
        }
    ],
    "type": "OK"
}