Skip to main content
POST
Parse a merchant packet (PDF / PNG / JPEG files)

Authorizations

X-API-Key
string
header
required

API key

Headers

Idempotency-Key
string | null

Retry-safe submission: the same key and request returns the same job; the same key with different files, order, metadata or options is refused (409)

Maximum string length: 200

Query Parameters

wait
integer
default:0

Seconds to wait for the result

Required range: 0 <= x <= 3600

Body

multipart/form-data
files
file[]
required

Documents of one merchant

options
string | null

ParseOptions as JSON

document_types
string[] | null

One declared type per file, in upload order: bank_statement.business, bank_statement.personal, credit_card_statement, tax_return.1040, tax_return.1120s, tax_return.1065, tax_return.w2, tax_return.1099_nec, application.mca, application.sba, agreement.mca, voided_check, drivers_license, coi.acord_25, coi.acord_27, unknown. Recorded, never used in place of the classifier

broker_email
string | null

The ISO / broker that sent it

Maximum string length: 320
contact_email
string | null

The merchant's contact

Maximum string length: 320
business_name
string | null

The merchant's legal name

Maximum string length: 255
business_ein
string | null

The merchant's EIN (9 digits)

Maximum string length: 32
external_business_id
string | null

Your id for the merchant: links its submissions

Maximum string length: 255
end_user_id
string | null

Your merchant record id, echoed

Maximum string length: 255
requested_advance_amount

Amount requested, USD

Required range: x >= 0

Response

OK

job_id
string
required
status
enum<string>
required
Available options:
queued,
running,
completed,
review_required,
failed
source
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
intake
JobIntakeOut · object
required

How the packet came in and what it declared, for every status

completed_at
string<date-time> | null
error
string | null
result
JobResult · object | null
superseded_by
string | null

A later job of the same email thread that holds this job's documents and more: read that one