Upload a document

Upload the IRS EIN letter, business formation documents, or a picture ID.

Use this endpoint to add a supporting document to the company.

📘

Part of Supporting documents. For how this fits into onboarding, see the guide: Collecting company information: documents.

Send the file as multipart/form-data in a part named file. The kind in the path is one of:

kindWhat it isNotes
IRS_EIN_LETTERThe IRS letter assigning the EINA new upload replaces the previous one.
BUSINESS_FORMATIONA business formation documentAdd as many as you have.
PICTURE_IDThe front or back of a person's IDNeeds personRef and side. Only when the company was created with documentCapture PARTNER.

For PICTURE_ID, pass personRef (control-person, owner-<id> or signer, from the identity verification list) and side (FRONT or BACK) as query parameters or form fields. Only people who must be verified have one: the control person, owners of 25% or more, and a signer who is neither. A passport needs only its FRONT.

RuleDetail
FormatPDF, PNG or JPEG.
SizeUp to 25 MB, and not empty.

When you can call this

While the onboarding is a DRAFT, including after the contract is signed. After submission, replacements are sent as the answer to a DOCUMENT_NEEDED request (see Fulfill a request with a file).

Errors

StatusMeaning
400The file is empty, too large or the wrong format; or a PICTURE_ID is missing its personRef or side, or the person doesn't need one.
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
409The onboarding is no longer a DRAFT, or pictures of IDs are captured by the identity provider (documentCapture is ALLOY).
Path Params
integer
required

The company's ID, as returned when the company was created.

string
enum
required

The kind of document.

Allowed:
Query Params
string

For a PICTURE_ID: the person it shows (control-person, owner-<id> or signer).

string
enum

For a PICTURE_ID: FRONT or BACK.

Allowed:
Body Params
file
required

The document, as a PDF, PNG or JPEG of up to 25 MB.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json