Skip to main content
GET
/
api
/
v2
/
documents
/
{id}
Get document by ID (v2)
curl --request GET \
  --url https://rest-api.captide.co/api/v2/documents/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "a586df65-76d8-4b04-864c-ceed76592f4d",
  "documentCategory": "interim-financial-report",
  "title": "First Quarter Report for period ending 31 March 2025",
  "description": "This document is the First Quarter Report of Santos Limited for the period ending 31 March 2025.",
  "date": "2025-04-17",
  "fiscalQuarter": 1,
  "fiscalYear": 2025,
  "fiscalPeriod": "quarter",
  "language": "en",
  "companyId": "77848abe-a215-41b7-8950-86e89ea1fadc",
  "companyName": "Santos",
  "companyTickers": [
    "STO.AX"
  ],
  "originalFileUrl": "https://files.captide.co/original-docs/...",
  "markdownFileUrl": "https://files.captide.co/markdown-docs/...",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

Document file ID

Response

Document found successfully

V2 response model for document retrieval by ID. Uses database category codes directly.

​
id
string
required

Unique document ID

​
documentCategory
string
required

Document category code as stored in the database. For detailed category descriptions, please refer to this page.

​
companyId
string
required

Unique ID of the company filing the document

​
originalFileUrl
string
required

Secure and temporary URL providing access to the original document file

​
markdownFileUrl
string
required

Secure and temporary URL providing access to the pre-processed, machine-readable document file

​
secFormType
string | null

Document SEC form type (only applicable if the document is an SEC filing)

​
title
string | null

Captide-generated document title

​
description
string | null

Captide-generated document description

​
date
string | null

Date the document relates to (e.g., the press release date for a current report, or the fiscal period end date for annual and interim reports)

​
fiscalQuarter
integer | null

Fiscal quarter the document relates to (from 1 to 4)

​
fiscalYear
integer | null

Fiscal year the document relates to (e.g., 2024)

​
fiscalPeriod
string | null

Fiscal period the document relates to. Valid values: year, multi-year, month, half-year, quarter, or null

​
language
string | null

Language of the document in ISO 639-1 code

​
companyName
string | null

Name of the company filing the document

​
companyTickers
string[]

Tickers of the company filing the document

​
metadata
Metadata · object

Additional document metadata (e.g., accessionNumber, 8kItems)