Generate Upload Document Url
Generates a presigned URL to upload a document to the brokerage firm. Provide document metadata in the body and any additional parameters in the query.
Authorizations
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Path Parameters
the brokerageFirm id
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Query Parameters
Optional: the whenAt datetime
Optional: the branchId
^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Body
Document metadata for upload
Response
Upload URL generated successfully.
type
the document's id
^document(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$url of the document
the Content-Type header that was signed into the presigned URL
the Content-Disposition header that was signed into the presigned URL

