Skip to main content
POST
Create a case or add an upload

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Optional. Makes the upload safe to retry: replaying the same key with an identical payload returns the original upload. Reusing a key with a different payload returns 409.

Body

multipart/form-data
files
file[]
required

One or more document files. Accepted formats: PDF, PNG, JPG, JPEG, WebP, ZIP. Max 20 files, 30 MB each, 40 MB total.

externalId
string
required

Your reference for this case. Unique per organization; subsequent submissions with the same externalId append to the existing case.

Required string length: 1 - 128
classify
boolean
default:true

Run AI document classification. When false, features run directly against the raw uploaded files instead of classified credentials.

features
string

JSON array of features to run. Defaults to all three. Example: ["extraction","forensics"]

Example:

"[\"extraction\",\"forensics\",\"translation\"]"

metadata
string

JSON object of key-value pairs (string, number, or boolean values).

Example:

"{\"cycle\":\"2025-fall\"}"

Response

Upload accepted for asynchronous processing.

success
boolean
required
Example:

true

message
string
required
meta
object
required

Optional metadata (e.g. pagination). Empty object when not applicable.

data
object
required