Skip to main content
POST
Start a document upload

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Path Parameters

dealId
string
required

Deal id

Body

application/json
name
string
required

File name including extension, e.g. chase-aug-2026.pdf. Path separators are stripped.

Maximum string length: 255
type
enum<string>
required

Document type. Use bank-statement for statements you want analyzed.

Available options:
application,
bank-statement,
tax-return,
voided-check,
contract,
drivers-license,
ach-authorization,
business-license,
proof-of-ownership,
utility-bill,
other
mime_type
string
required

MIME type of the file you will PUT, e.g. application/pdf, image/jpeg. Must match the Content-Type header of the upload.

Maximum string length: 100
file_size
number

Size in bytes, if known. Verified against the stored object on finalize.

Required range: x >= 1

Response

Created

data
object
required
meta
object
required