Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get All Documents For a Private Placement Offer

This request returns the list of required and non-required documents that are provided by the issuer to investors interested in making a subscription. Those documents marked as required must be presented to investors prior to any submission of subscription.

Request URL

Syntax GET /restapi/privateplacementoffers/{privateplacementofferoid}/documents
Example URL

Request Header Fields

Field Required? Description
X-Associated-Member-Id Yes When an advisor downloads a document list on behalf of a client, the client’s username must be sent in the X-Associated-Member-Id header.

Response Data Fields

Field Description
id The unique identifier of a document associated with the offer.
loginIdViewing The username of the end user for whom the currently logged-in member (advisor) retrieves the document.
name The name of the document. (e.g. “Offering Memorandum”, “Private Placement Memorandum”, “Subscription Agreement”, etc.
required A Boolean indicator of whether the document is required or not. “true” or “false”. If the document is required, subscription can be made only after the document is viewed.
signable A Boolean indicator of whether the document is signable or not. “true” or “false”. If documentationExternal is false and a signable document has been viewed by the investor who subscribes to the offer, the document is recorded as being signed in our database when the subscription is submitted.
version The version of the document. The format is majorVersion.minorVerion.
viewed A Boolean indicator of whether the latest version of the document has been viewed for the member loginIdViewing before: “true” or “false”. This field is a placeholder for future usage and returns always ‘false’. API clients should not use this information until further notice.

Response Example

HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1[
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 18 Feb 2014 22:21:48 GMT

   "required" : true,
   "title":"Private Placement Memorandum",
   "required" : true,
   "title":"Subscription Agreement",
   "name":"PP Order Agreement Placeholder.pdf",
   "required" : true,
   "title":"PP Order Agreement",

Change Log


  1. Updated the description of loginIdViewing


  1. Updated Response Data Fields
  2. Updated Response Example


  1. Updated Example URL


  1. Added Change Log

Getting Started