Skip to main content
POST
Upload document

Authorizations

​
Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

​
business_id
string<uuid>
required

The ID of the portfolio business to upload the document for.

Example:

"987e6543-e21a-45b6-c789-012345678901"

Body

multipart/form-data
​
file
file
required

The document file to upload.

​
types
enum<string>[]

All document types that apply to the file, sent as repeated types form fields. The first entry is the primary type. Required unless type is sent.

Available options:
passport,
drivers_license,
national_id,
government_id,
articles_of_incorporation,
certificate_of_formation,
operating_agreement,
bylaws,
ein_letter,
ein_letter_alternate,
business_license,
certificate_of_good_standing,
certificate_of_authority,
bank_statement,
tax_return,
filing_confirmation,
welcome_letter,
proof_of_address,
service_of_process,
notice,
mail,
ra_change_confirmation,
ra_resignation,
receipt,
other
Example:
​
type
enum<string>
deprecated

Deprecated: use types. A single document type, equivalent to types with one entry. Not accepted together with types.

Available options:
passport,
drivers_license,
national_id,
government_id,
articles_of_incorporation,
certificate_of_formation,
operating_agreement,
bylaws,
ein_letter,
ein_letter_alternate,
business_license,
certificate_of_good_standing,
certificate_of_authority,
bank_statement,
tax_return,
filing_confirmation,
welcome_letter,
proof_of_address,
service_of_process,
notice,
mail,
ra_change_confirmation,
ra_resignation,
receipt,
other
Example:

"articles_of_incorporation"

​
metadata
object

Additional metadata, sent either as a JSON object string or as repeated metadata[key] form fields.

Example:

Response

Document uploaded

​
id
string<uuid>
required

Unique identifier for the document. Pass this to the document download endpoints.

Example:

"906f369f-a73b-46a2-8184-ccc5c2848abd"

​
object
enum<string>
required

Object type identifier, always "document"

Available options:
document
Example:

"document"

​
mode
enum<string>
required

Whether this resource is test or live; test and live data are isolated.

Available options:
test,
live
Example:

"live"

​
resource_type
enum<string>
required

Whether this document belongs to a business or to a person.

Available options:
user,
business
Example:

"business"

​
resource_id
string<uuid>
required

ID of the business or person this document belongs to. Use it to route a document delivered by webhook without a follow-up lookup.

Example:

"987e6543-e21a-45b6-c789-012345678901"

​
related_items
object[]
required

The work this document is part of, such as the case it was submitted in response to or the filing it was produced by. References only; empty when the document is not tied to any work.

​
types
enum<string>[]
required

All document types that apply to this document.

Available options:
passport,
drivers_license,
national_id,
government_id,
articles_of_incorporation,
certificate_of_formation,
operating_agreement,
bylaws,
ein_letter,
ein_letter_alternate,
business_license,
certificate_of_good_standing,
certificate_of_authority,
bank_statement,
tax_return,
filing_confirmation,
welcome_letter,
proof_of_address,
service_of_process,
notice,
mail,
ra_change_confirmation,
ra_resignation,
receipt,
other
Example:
​
type
enum<string>
required
deprecated

Deprecated: use types. The first entry of types.

Available options:
passport,
drivers_license,
national_id,
government_id,
articles_of_incorporation,
certificate_of_formation,
operating_agreement,
bylaws,
ein_letter,
ein_letter_alternate,
business_license,
certificate_of_good_standing,
certificate_of_authority,
bank_statement,
tax_return,
filing_confirmation,
welcome_letter,
proof_of_address,
service_of_process,
notice,
mail,
ra_change_confirmation,
ra_resignation,
receipt,
other
Example:

"articles_of_incorporation"

​
filename
string
required

Original filename of the uploaded document

Maximum string length: 255
Example:

"articles_of_incorporation.pdf"

​
file_size
number
required

Size of the file in bytes

Required range: x >= 0
Example:

524288

​
content_type
string
required

MIME type of the file

Example:

"application/pdf"

​
status
enum<string>
required

Current status of the document

Available options:
pending,
verified
Example:

"verified"

​
upload_date
string<date-time>
required

ISO 8601 timestamp when the document was uploaded

Example:

"2025-10-24T10:30:00Z"

​
metadata
object
required

Custom metadata

Example:
​
created_at
string<date-time>
required

ISO 8601 timestamp when the document record was created

Example:

"2025-10-24T10:30:00Z"

​
updated_at
string<date-time>
required

ISO 8601 timestamp when the document record was last updated

Example:

"2025-10-24T10:35:00Z"