DOdocsumo
Documents

Upload a File

Upload a document file directly. The file will be processed according to the specified document type.

post/api/v1/eevee/apikey/upload/

Request

  • Base URL
    https://app.docsumo.com
  • URL
    https://app.docsumo.com/api/v1/eevee/apikey/upload/
  • Auth
    none declared. Required headers: apikey

Headers

apikeystring required

Your personal API key for authentication. You can find it on your Docsumo settings page.

Request body multipart/form-data

filestring binary required

The document file to be uploaded.

typestring required

The type of document being uploaded. Obtain the list of available types from the 'Get User Details and Document Types' endpoint.

user_doc_idstring

An optional, unique identifier that you can assign to the document for your own internal tracking purposes.

doc_meta_datastring

Optional JSON string containing any additional metadata you want to associate with the document.

review_tokenboolean

If true, the response will include a temporary, signed review URL that can be shared with external users.

Example request

{
  "type": "invoice"
}

Response

OK

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error, if any.

messagestring

Additional information or context about the response.

statusstring

The status of the request (e.g., 'success' or 'fail').

status_codeinteger

The HTTP status code of the response.

Changes

No recorded changes to this operation across all 2 revisions of this API.