Skip to main content

startDocumentUpload

Accepts a file the merchant wants to keep and hands back a short-lived, write-only address to send it to. The record it creates is visible straight away as PENDING_UPLOAD, and stays that way until finalizeDocument confirms the file arrived.

**Returns:**

Somewhere to send the file, or the business reason nothing was accepted.

startDocumentUpload(
  input: StartDocumentUploadInput!
): StartDocumentUploadResult!

Arguments​

startDocumentUpload.input ● StartDocumentUploadInput! non-null input​

What the file is, how large, and what it belongs to.

Type​

StartDocumentUploadResult union​

The outcome of startDocumentUpload: either somewhere to send the file, or the business reason nothing was accepted.