POST
Ingest a document

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Body

application/json
file
string
required
type
string
attach_to
object
apply
enum<string>
Available options:
auto,
review,
none

Response

OK

id
string
required
object
enum<string>
required
Available options:
document_ingestion
status
enum<string>
required
Available options:
processing,
needs_review,
applied,
rejected,
failed
file
string
required
type
string
detected_type
string | null
format
enum<string>
Available options:
pdf_text,
pdf_scanned,
image,
edi_x12,
edifact,
ubl,
xml,
json
extraction
object
attach_to
object | null
document
string | null
job
string | null
messages
object[]