GET api/v2/investor/accounts/documents?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}
Returns a list of documents for a given account and user.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientIdentifier |
source system client identifier for end-user |
string |
Required |
accountNumber |
unique identifier for account |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of document models
ApiListResponseOfInvestorDocumentModelName | Description | Type | Additional information |
---|---|---|---|
Records | Collection of InvestorDocumentModel |
None. |
|
TotalLength | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Records": [ { "VaultFileId": 1, "ParentId": 1, "Name": "sample string 2", "ParentName": "sample string 3", "FilePath": "sample string 4", "Extension": "sample string 5", "UploadDate": "2025-01-02T15:55:30.9261756-06:00", "FileSize": 7, "AddedById": 1, "AddedByName": "sample string 8", "IsFolder": true, "Path": "sample string 10", "NumberOfFiles": 11, "NumberOfFolders": 12, "SortOrder": 1, "Associations": [ { "InvestorId": 1, "VaultFileAssociationId": 2, "VaultFileId": 3, "WealthAccountId": 1, "WealthId": 1, "Name": "sample string 4" }, { "InvestorId": 1, "VaultFileAssociationId": 2, "VaultFileId": 3, "WealthAccountId": 1, "WealthId": 1, "Name": "sample string 4" } ], "Permissions": [ { "AdvisorId": 1, "AdvisorName": "sample string 2", "AllowedToSee": true, "CanEdit": true }, { "AdvisorId": 1, "AdvisorName": "sample string 2", "AllowedToSee": true, "CanEdit": true } ], "LastReadDate": "2025-01-02T15:55:30.9261756-06:00", "CanDelete": true, "CanRename": true, "CanMove": true }, { "VaultFileId": 1, "ParentId": 1, "Name": "sample string 2", "ParentName": "sample string 3", "FilePath": "sample string 4", "Extension": "sample string 5", "UploadDate": "2025-01-02T15:55:30.9261756-06:00", "FileSize": 7, "AddedById": 1, "AddedByName": "sample string 8", "IsFolder": true, "Path": "sample string 10", "NumberOfFiles": 11, "NumberOfFolders": 12, "SortOrder": 1, "Associations": [ { "InvestorId": 1, "VaultFileAssociationId": 2, "VaultFileId": 3, "WealthAccountId": 1, "WealthId": 1, "Name": "sample string 4" }, { "InvestorId": 1, "VaultFileAssociationId": 2, "VaultFileId": 3, "WealthAccountId": 1, "WealthId": 1, "Name": "sample string 4" } ], "Permissions": [ { "AdvisorId": 1, "AdvisorName": "sample string 2", "AllowedToSee": true, "CanEdit": true }, { "AdvisorId": 1, "AdvisorName": "sample string 2", "AllowedToSee": true, "CanEdit": true } ], "LastReadDate": "2025-01-02T15:55:30.9261756-06:00", "CanDelete": true, "CanRename": true, "CanMove": true } ], "TotalLength": 1 }
application/xml, text/xml
Sample:
<ApiListResponseOfInvestorDocumentModelV4p3MQZm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models"> <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models"> <d2p1:InvestorDocumentModel> <d2p1:AddedById>1</d2p1:AddedById> <d2p1:AddedByName>sample string 8</d2p1:AddedByName> <d2p1:Associations> <d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorId>1</d2p1:InvestorId> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:VaultFileAssociationId>2</d2p1:VaultFileAssociationId> <d2p1:VaultFileId>3</d2p1:VaultFileId> <d2p1:WealthAccountId>1</d2p1:WealthAccountId> <d2p1:WealthId>1</d2p1:WealthId> </d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorId>1</d2p1:InvestorId> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:VaultFileAssociationId>2</d2p1:VaultFileAssociationId> <d2p1:VaultFileId>3</d2p1:VaultFileId> <d2p1:WealthAccountId>1</d2p1:WealthAccountId> <d2p1:WealthId>1</d2p1:WealthId> </d2p1:InvestorVaultFileAssociationModel> </d2p1:Associations> <d2p1:CanDelete>true</d2p1:CanDelete> <d2p1:CanMove>true</d2p1:CanMove> <d2p1:CanRename>true</d2p1:CanRename> <d2p1:Extension>sample string 5</d2p1:Extension> <d2p1:FilePath>sample string 4</d2p1:FilePath> <d2p1:FileSize>7</d2p1:FileSize> <d2p1:IsFolder>true</d2p1:IsFolder> <d2p1:LastReadDate>2025-01-02T15:55:30.9261756-06:00</d2p1:LastReadDate> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:NumberOfFiles>11</d2p1:NumberOfFiles> <d2p1:NumberOfFolders>12</d2p1:NumberOfFolders> <d2p1:ParentId>1</d2p1:ParentId> <d2p1:ParentName>sample string 3</d2p1:ParentName> <d2p1:Path>sample string 10</d2p1:Path> <d2p1:Permissions> <d2p1:InvestorDocumentPermissionModel> <d2p1:AdvisorId>1</d2p1:AdvisorId> <d2p1:AdvisorName>sample string 2</d2p1:AdvisorName> <d2p1:AllowedToSee>true</d2p1:AllowedToSee> <d2p1:CanEdit>true</d2p1:CanEdit> </d2p1:InvestorDocumentPermissionModel> <d2p1:InvestorDocumentPermissionModel> <d2p1:AdvisorId>1</d2p1:AdvisorId> <d2p1:AdvisorName>sample string 2</d2p1:AdvisorName> <d2p1:AllowedToSee>true</d2p1:AllowedToSee> <d2p1:CanEdit>true</d2p1:CanEdit> </d2p1:InvestorDocumentPermissionModel> </d2p1:Permissions> <d2p1:SortOrder>1</d2p1:SortOrder> <d2p1:UploadDate>2025-01-02T15:55:30.9261756-06:00</d2p1:UploadDate> <d2p1:VaultFileId>1</d2p1:VaultFileId> </d2p1:InvestorDocumentModel> <d2p1:InvestorDocumentModel> <d2p1:AddedById>1</d2p1:AddedById> <d2p1:AddedByName>sample string 8</d2p1:AddedByName> <d2p1:Associations> <d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorId>1</d2p1:InvestorId> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:VaultFileAssociationId>2</d2p1:VaultFileAssociationId> <d2p1:VaultFileId>3</d2p1:VaultFileId> <d2p1:WealthAccountId>1</d2p1:WealthAccountId> <d2p1:WealthId>1</d2p1:WealthId> </d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorVaultFileAssociationModel> <d2p1:InvestorId>1</d2p1:InvestorId> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:VaultFileAssociationId>2</d2p1:VaultFileAssociationId> <d2p1:VaultFileId>3</d2p1:VaultFileId> <d2p1:WealthAccountId>1</d2p1:WealthAccountId> <d2p1:WealthId>1</d2p1:WealthId> </d2p1:InvestorVaultFileAssociationModel> </d2p1:Associations> <d2p1:CanDelete>true</d2p1:CanDelete> <d2p1:CanMove>true</d2p1:CanMove> <d2p1:CanRename>true</d2p1:CanRename> <d2p1:Extension>sample string 5</d2p1:Extension> <d2p1:FilePath>sample string 4</d2p1:FilePath> <d2p1:FileSize>7</d2p1:FileSize> <d2p1:IsFolder>true</d2p1:IsFolder> <d2p1:LastReadDate>2025-01-02T15:55:30.9261756-06:00</d2p1:LastReadDate> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:NumberOfFiles>11</d2p1:NumberOfFiles> <d2p1:NumberOfFolders>12</d2p1:NumberOfFolders> <d2p1:ParentId>1</d2p1:ParentId> <d2p1:ParentName>sample string 3</d2p1:ParentName> <d2p1:Path>sample string 10</d2p1:Path> <d2p1:Permissions> <d2p1:InvestorDocumentPermissionModel> <d2p1:AdvisorId>1</d2p1:AdvisorId> <d2p1:AdvisorName>sample string 2</d2p1:AdvisorName> <d2p1:AllowedToSee>true</d2p1:AllowedToSee> <d2p1:CanEdit>true</d2p1:CanEdit> </d2p1:InvestorDocumentPermissionModel> <d2p1:InvestorDocumentPermissionModel> <d2p1:AdvisorId>1</d2p1:AdvisorId> <d2p1:AdvisorName>sample string 2</d2p1:AdvisorName> <d2p1:AllowedToSee>true</d2p1:AllowedToSee> <d2p1:CanEdit>true</d2p1:CanEdit> </d2p1:InvestorDocumentPermissionModel> </d2p1:Permissions> <d2p1:SortOrder>1</d2p1:SortOrder> <d2p1:UploadDate>2025-01-02T15:55:30.9261756-06:00</d2p1:UploadDate> <d2p1:VaultFileId>1</d2p1:VaultFileId> </d2p1:InvestorDocumentModel> </Records> <TotalLength>1</TotalLength> </ApiListResponseOfInvestorDocumentModelV4p3MQZm>