Documents API

The Document List API provides an endpoint to retrieve a list of documents in a company company's cap table. The end point performs authorization checks, retrieves the necessary data, and returns the relevant document information.

Endpoint URL

https://equity-api.diligentoneplatform.com/api/v2/docs

Authentication

The Diligent Equity API uses JSON web token for authentication. The token must be sent in the header of the request.

To get a token, contact our support team at equity@diligent.com.

After you have received the token, add the following text in the header of all requests:

Authorization: Bearer {your token}

Query parameters

Name	Type	Description
userId (optional)	String
firmID (optional)	String

Example request

curl --location --request GET 'https://equity-api.diligentoneplatform.com/api/v2/docs' \
--header 'Authorization: Bearer [API_TOKEN]'

Response fields

General fields

Example response

[
  {
    "fileName": "Captable test",
    "fileId": "doc6a23fe3d29885",
    "main": false,
    "from": "",
    "permission": "admi",
    "modified": "2020-07-23T03:09:02.000Z",
    "firmID": "",
    "firmPermission": "",
    "hasLogo": 0,
    "isShared": true
  },
  {
    "fileName": "Test document",
    "fileId": "doc5a116a358350e",
    "main": false,
    "from": "",
    "permission": "admi",
    "modified": "2021-08-05T11:10:32.000Z",
    "firmID": "",
    "firmPermission": "",
    "hasLogo": 0,
    "isShared": true
  }
]

Name	Type	Description
fileName	String	The name of the document.
fileId	String	The ID of the document.
main	Boolean	Indicates whether the document is the main document of the account.
from
permission	String	The permission the current account has on the document.
modified	Date	The date when the document was last modified.
firmID		FEATURE BASED: the id of the firm the document belongs to
firmPermission		FEATURE BASED: the permission the current account has on the firm the document belongs to
hasLogo	Number	FEATURE BASED: is there a logo file stored for this document
isShared	Boolean	Indicates whether the document is shared.