API Reference
  1. PCE Boarding APIs
  2. Business Documents

Upload a business document

post
https://sandbox-api.prioritycommerce.com/v1/businesses//documents

Registers a document for the business and returns a secure uploadUrl. Upload the file to that URL using the returned method and headers before expiresAt. The document status is pending_upload until the file is received.

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

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

Body Params

Details of the document file you are about to upload.

string
enum
required

Type of document.

string
required
length ≤ 255

Name of the file, including its extension, for example business-license.pdf.

string
required

File format, for example application/pdf, image/png or image/jpeg.

number
≤ 104857600

Size of the file in bytes.

string
length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

Responses

Updated about 19 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 19 hours ago

Did this page help you?
.readme-logo { display: none !important; }