Skip to main content
POST
Upload a document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

verification_id
string<uuid>
required

Body

multipart/form-data

One document, and where in the workflow it belongs.

step_key
string
required

The step this document answers.

Minimum string length: 1
slot
string
required

The named slot on that step it answers.

Minimum string length: 1
file
file
required

The document itself.

kind
string | null

Which of the slot's kinds this document is. A slot naming several needs one of them; a slot naming one takes the document as that one.

Minimum string length: 1

Response

The stored file.

One file on the record, whether the user uploaded it or the step fetched it on their behalf.

id
string<uuid>
required

The document's id, used to download it.

slot
string
required

The named slot the file sits in.

kind
string
required

Which of its slot's kinds the file was provided as. Every slot names at least one, and intake.slots names them for every step answered over this API. A file a check fetched carries the kind of document the source returned, and a photo taken on the person's own screens carries the kind of photo it was asked for.

label
string | null
required

That kind's name in your own system, where your workflow gives it one. The same label on the same document across branches is how you find it without knowing which branch ran.

filename
string
required

The original filename.

content_type
string
required

The file's MIME type.

size_bytes
integer
required

The file's size in bytes.

sha256
string
required

The SHA-256 hash of the file's contents.

received_at
string<date-time>
required

When the file was received.