API Reference
  1. PCE Boarding APIs
  2. Document Library

Add a library document

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

Registers a document in your document library and returns a secure uploadUrl for the file. Library documents, such as the merchant agreement, are not tied to a business. Attach one to a business by passing its id in documents when you create or update the business.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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; }