Upload business documents

This POST endpoint is used to upload documents for a business created with POST /business: a KYB report, articles of incorporation, a proof of address, and so on.
You must specify the business_token in the URL path. The caller must be the account that created the business, or the business itself using its own API key.
In the request body, include an array of documents. Each document requires a document_type, the original file_name (with its extension) and its Base64-encoded file_content; an optional description adds context, for other in particular.
Every document is validated and virus-scanned before any is stored, so a rejected document rejects the whole request and nothing is written.
A document may be at most 4,500,000 bytes once decoded and a request may carry at most 10 documents; the whole request must also stay under the 6 MB API limit (Base64 adds a third to each file), so larger sets go in several requests to POST /business/{business_token}/documents.
The response lists the documents stored, in request order, each with its document_token. A document that could not be stored is left out: compare the response with what you sent and resend what is missing. Uploads only add documents; nothing already on file is replaced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The business_token returned by POST /business (a bare UUID, no prefix)

Body Params
documents
array of objects
required
length between 1 and 10

The documents to add to the business.

documents*

A document submitted for a business (KYB report, articles of incorporation, proof of address, ...): an entry of the documents array of POST /business and POST /business/{business_token}/documents. A document may be at most 4,500,000 bytes once decoded and a request may carry at most 10 documents; the whole request must also stay under the 6 MB API limit (Base64 adds a third to each file), so larger sets go in several requests to POST /business/{business_token}/documents.

string
enum
required

What the document is. Use other for anything not listed and say what it is in description.

string
required
length ≤ 255

Original file name including its extension; any directory part is dropped. Supported extensions: pdf, jpg, jpeg, png, gif, bmp, tif, tiff, webp, heic, heif, doc, docx. The extension decides how the file is stored and served.

string
required

Base64-encoded file content; a data:...;base64, prefix is accepted. At most 4,500,000 bytes once decoded.

string
length ≤ 255

Optional note for our underwriting team, such as what an other document is or which period a statement covers.

Responses

400

Bad Request

401

Unauthorized

403

You do not have necessary permissions for the resource

404

Business not found: the token is unknown, or the business was neither created by your account nor is your own

500

Internal Server Error

504

Gateway Timeout

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json