Skip to main content
POST
Create a document from an uploaded file

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Body

application/json
uploadKey
string
required

uploadKey from the presign step, after the PUT succeeded.

Minimum string length: 1
documentType
enum<string>

Which kind of document this is, when the caller knows. Preserved over the AI classifier's own guess; omit it and the classifier decides.

Available options:
RECEIPT,
BILL,
INVOICE,
REIMBURSEMENT
uploadContext
enum<string>

Which side of the books the file came from when the caller knows only that: money_out (the business pays) or money_in (the business is owed). A weak prior for the classifier, which the document's own evidence and a named documentType both outrank.

Available options:
money_in,
money_out
counterpartyName
string

Vendor (receipt/bill) or customer (invoice) the user named.

Required string length: 1 - 200
amount
string

Grand total the user stated, in currency.

Pattern: ^\d+(\.\d+)?$
currency
enum<string>

ISO currency the user stated. Omit to let extraction decide.

Available options:
CAD,
USD,
EUR,
GBP,
AUD
documentDate
string

Receipt/issue date printed on the document.

Pattern: ^\d{4}-\d{2}-\d{2}$
note
string

Any other context the user gave about this document.

Required string length: 1 - 2000

Response

201 - application/json

Ingested document

document
object
required