GET
/Document
Usage Notes
When
- Retrieve document metadata by ID
- Query documents by entity association
Requirements
- DocumentID, ExternalDocumentId, or entity ID
Notes
- Returns metadata only - use GET /Document/File for content
Description
Retrieves document metadata including type, entity association, and access settings.
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
}
}