Documents

Get document list

To get the list of documents provided by your company or connection under a secific company type, call the GET /api/companies/{company-id}/company-types/{companyTypeId}/documents endpoint.

GET /api/companies/{company-id}/company-types/{companyTypeId}/documents

[
  {
    "id": DOCUMENT-ID,
    "name": "Example document.pdf",
    "category": "Operation",
    "type": "Portfolio management",
    "issueDate": "2024-01-03T00:00:00",
    "expirationDate": "2024-06-30T00:00:00"
  },
  {
    "id": DOCUMENT-ID,
    "name": "Example document 2.xlsx",
    "category": "Management",
    "type": "List of executive managers",
    "issueDate": "2023-01-15T00:00:00",
    "expirationDate": "2024-04-22T00:00:00"
  },
  ...
]
                

Get document URL

To get the document URL for download, call the GET /api/documents/{document-id}/url endpoint.

GET /api/documents/{document-id}/url

{
  "url": "https://..."
}