Skip to content

Upload document

Request

Upload a signed document to the system in order to run subsequent operations (signature report, verification, content extraction, etc.).

You can upload:

  • a single signed file (embedded signature), or
  • two separate files: the main document plus a detached signature.

The request must be multipart/form-data.

Notes:

  • The optional verification_date fixes the verification date used by VOL; if omitted VOL chooses a date depending on the verification profile.
Security
AuthToken
Bodymultipart/form-datarequired
documentstring, (binary)required

Main document to upload (must be signed when using embedded signatures)

contentstring, (binary)

Detached signature (optional). If omitted, VOL searches for the signature inside document.

verification_datestring

Verification date to be used by VOL. The documentation describes this as a form field named verification_date.

Example:"2017-12-20T11:46:36.862950"
curl -i -X POST \
  https://example.com/api/documents/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F document=@document.bin \
  -F content=@content.bin \
  -F verification_date=2017-12-20T11:46:36.862950

Responses

Document uploaded successfully

Headers
locationstring

Relative URL of the uploaded document (contains the unique document-id)

Example:"/documents/e4d13719410fae2f"
Bodyapplication/json
codestringrequired
Example:"201 Created"
locationstringrequired

Relative URL to access the uploaded document (contains document-id)

Example:"/documents/e4d13719410fae2f"
Response
{ "code": "201 Created", "location": "/documents/e4d13719410fae2f" }