User Document list

Endpoint URL

https://equity-api.highbond.com/api/v2/documents/list

Note

The signatureStatus, signedBy, and waitingFor fields may not be up to date. You may need to refresh the document’s status in the Captable and try again.

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
docId String The document ID used to identify the queried company.
auth Text Authorization token key

Example request

curl --location --request GET 'https://equity-api.highbond.com/api/v2/documents/list?docId=[DOCUMENT_ID]'
 \--header 'Authorization: Bearer [API_TOKEN]

Response fields

General fields

Example Response

Note

This example shows only the relevant parts of the response. You can view the example in full here.

"message": [{
"dateOfCreation": "2024-07-11T07:10:58.000Z",
"documentName": "RSU Grant Notice Template",
"shareholder": "John Doe",
"issuanceName": "John_Doe_RSU_Grant_Notice_2021",
"documentType": "Template",
"signatureStatus": "partially signed",
"signedBy": "John Doe, Ceo Charlie",
"waitingFor": "Manager Janelle, 
HR Advisor Hugo"
},[...]
Name Type Description
dateOfCreation Date Date the document is created
documentName String Name of document
shareholder String Shareholder for whom the document is created
issuanceName String Name of the affected issuance (option, share, notes, warrants) the document is created for
documentType String Type of the document. Example: Template or Certificate.
signatureStatus String Status of signatures, if an external document signing application, like DocuSign, is included.
Make sure the status has been refreshed when the API call is happening.
signedBy String Name of people who have already signed the document.
waitingFor String Name of people who have not signed the document yet.