GET
/Document
When to Use
- Retrieve document metadata by documentID or externalDocumentId
- Build document lists for investor portals with visibility settings
- Locate documents associated with specific entities or products
- Validate document properties before downloading file content
Common Scenarios
- Investor Portal Display: Show available documents filtered by
showInDocumentsInPortalflag - Document Type Filtering: Retrieve documents by type (statements, reports, compliance docs) using
documentTypeID - Entity-Specific Documents: Get all documents for a specific investor or organisation
- External System Integration: Synchronize document metadata using external identifiers
Prerequisites
- Valid Bearer token with document read permissions
- Either DocumentID or ExternalDocumentId must be provided
Considerations
- Metadata Only: Returns document properties without file content - use
/Document/Filefor actual file download - Single Document Return: This endpoint returns one document at a time based on the provided identifier
- Portal Visibility Control:
showInDocumentsInPortaldetermines client portal visibility - Public Access Flag:
isPublicindicates if document is accessible without authentication - Password Protection: Protected documents may have a password field populated
Description
Retrieves a single document record with complete metadata based on the provided identifier. Returns comprehensive document information including type, name, description, associated entities (BizEntity, Organisation, Product), and visibility settings without transferring the actual file content.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DocumentID |
integer | The native 7G identifier for the document. Use this for direct document lookup. | |
ExternalDocumentId |
string | Your external system identifier for the document. Alternative to DocumentID for document lookup. | |
ProductID |
integer | Native 7G product identifier for enhanced security validation. | |
ExternalProductId |
string | Client-supplied product reference for enhanced security validation. |
DocumentID
The native 7G identifier for the document. Use this for direct document lookup.
ExternalDocumentId
Your external system identifier for the document. Alternative to DocumentID for document lookup.
ProductID
Native 7G product identifier for enhanced security validation.
ExternalProductId
Client-supplied product reference for enhanced security validation.
Example Requests
bash
# Get specific document by ID with security validation
curl -X GET "https://api.7g.com.au/Document?DocumentID=12345&ProductID=100" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"
# Get document by external ID with external product validation
curl -X GET "https://api.7g.com.au/Document?ExternalDocumentId=DOC_2024_001&ExternalProductId=FUND-001" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0"Response Examples
json
{
"result": true,
"message": null,
"data": {
"documentID": 12345,
"externalDocumentId": "DOC_2024_001",
"documentTypeID": 1,
"name": "Monthly Investment Statement - March 2024",
"code": "STMT_202403",
"description": "Monthly investment statement for March 2024 including holdings, transactions, and performance metrics",
"password": null,
"ordinal": 1,
"productID": 100,
"externalProductId": "PROD_GROWTH_FUND",
"bizEntityID": 67890,
"externalBizEntityId": "CLIENT_ENT_001",
"organisationID": null,
"externalOrganisationId": null,
"showInDocumentsInPortal": true,
"isPublic": false
}
}