User Holders list

Endpoint URL

https://equity-api.highbond.com/api/v2/holders/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/holders/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": 
{
"type": "shareholder",
"name": "Brando Parisian",
"email": "brando@test.com",
"region": "USA",
"role": "shareholder",
"title": "manager",
"department": "management",
"subdepartment": "payroll, 
"gender": "male",
       
"address": "Washington, Main street 9",
        
"city": "Washington - DC",
        
"zip": "123456",
        
"country": "United States of America",
       
"state": "Washington DC",
        
"phone": "+1-123456789",
        
"personalemail": "brando@mailme.com",
        
"registrationname": "Brando PArisian",
        
"legalentity": "n/a",
        
"taxid": "123456789",
       
"taxidtype": "ASDF123456",
       
"entitytype": "management",
        
"investortype": "employee",
        
"subinvestortype": "employee",
        
"comments": "he is the head of payroll"
},[...]
Name Type Description
type String The type of holder
name String Holder's name
email String Holder's email address
region String Holder's region
role String Holder's role
title String Holder's title
department String Holder's department
subdepartment String Sub-department name
gender String Holder's gender
address String Full address of holder
city String City in holder’s address
zip String Holder’s zip code
country String Country of holder’s address
state String Holder’s state
phone String Holder’s phone number
personalemail String Holder’s personal email address
legalentity String Holder’s registered name
taxid String Holder’s tax ID
taxidtype String Holder’s type of tax ID
entitytype String Entity type
investortype String Holder’s investor type. Example: Co-investor, CEO, CTO, or employee.
subinvestortype String Holder’s sub-investor type. Example: XY Fund Management, ZAA Venture Capital, or Management.
comments String Any comments that have been added as free text