Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get a Document For a Private Placement Offer
This request returns the specific document requested for an offer. See Get All Documents For a Private Placement Offer to view the list of available documents for an offer.
E-signature Note: Electronic signature capture begins on your site, such as an authenticated user on your web site agreeing to the terms of an offering document by marking a required “I Agree” checkbox next to the document file (which Folio will generally review on your site prior to use). All requests to API endpoints are time stamped (when sent, when received, and when response is sent—3 timestamps per call) and this is Folio’s record of users’ agreements to such terms.
Request URL
| Syntax | GET /restapi/privateplacementoffers/{privateplacementofferoid}/documents/{documentid} |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/privateplacementoffers/9007199254740992156/documents/410f0f6c-b485-440f-9840-b0e8125692a3 |
Request Header Fields
| Field | Required? | Description |
|---|---|---|
| X-Associated-Member-Id | Yes | When an advisor downloads a document on behalf of a client, the client’s username must be sent in the X-Associated-Member-Id header. |
Response Data Fields
The downloaded document is transmitted as a bytestream in the HTTP message body.
Response Example
HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Cache-Control: private, max-age=3599
Expires: Tue, 18 Feb 2014 23:58:30 GMT
Content-Disposition: attachment; filename=testdoc1.pdf
Server: Apache-Coyote/1.1
Date: Tue, 18 Feb 2014 22:58:31 GMT
Content-Type: application/pdf
Content-Length: 8217
--- byte stream of the document ---
Change Log
07/22/2016
- Updated Example URL
04/29/2016
- Added Change Log