POST api/v2/investor/accounts/documents?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}

Uploads a document for a given account and user.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Document Model

InvestorDocumentModel
NameDescriptionTypeAdditional information
VaultFileId

integer

None.
ParentId

integer

None.
Name

string

None.
ParentName

string

None.
FilePath

string

None.
Extension

string

None.
UploadDate

date

None.
FileSize

integer

None.
AddedById

integer

None.
AddedByName

string

None.
IsFolder

boolean

None.
Path

string

None.
NumberOfFiles

integer

None.
NumberOfFolders

integer

None.
SortOrder

integer

None.
Associations

Collection of InvestorVaultFileAssociationModel

None.
Permissions

Collection of InvestorDocumentPermissionModel

None.
LastReadDate

date

None.
CanDelete

boolean

None.
CanRename

boolean

None.
CanMove

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "VaultFileId": 1,
  "ParentId": 1,
  "Name": "sample string 2",
  "ParentName": "sample string 3",
  "FilePath": "sample string 4",
  "Extension": "sample string 5",
  "UploadDate": "2025-01-02T15:39:30.096861-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:39:30.096861-06:00",
  "CanDelete": true,
  "CanRename": true,
  "CanMove": true
}

application/xml, text/xml

Sample: 
<InvestorDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models">
  <AddedById>1</AddedById>
  <AddedByName>sample string 8</AddedByName>
  <Associations>
    <InvestorVaultFileAssociationModel>
      <InvestorId>1</InvestorId>
      <Name>sample string 4</Name>
      <VaultFileAssociationId>2</VaultFileAssociationId>
      <VaultFileId>3</VaultFileId>
      <WealthAccountId>1</WealthAccountId>
      <WealthId>1</WealthId>
    </InvestorVaultFileAssociationModel>
    <InvestorVaultFileAssociationModel>
      <InvestorId>1</InvestorId>
      <Name>sample string 4</Name>
      <VaultFileAssociationId>2</VaultFileAssociationId>
      <VaultFileId>3</VaultFileId>
      <WealthAccountId>1</WealthAccountId>
      <WealthId>1</WealthId>
    </InvestorVaultFileAssociationModel>
  </Associations>
  <CanDelete>true</CanDelete>
  <CanMove>true</CanMove>
  <CanRename>true</CanRename>
  <Extension>sample string 5</Extension>
  <FilePath>sample string 4</FilePath>
  <FileSize>7</FileSize>
  <IsFolder>true</IsFolder>
  <LastReadDate>2025-01-02T15:39:30.096861-06:00</LastReadDate>
  <Name>sample string 2</Name>
  <NumberOfFiles>11</NumberOfFiles>
  <NumberOfFolders>12</NumberOfFolders>
  <ParentId>1</ParentId>
  <ParentName>sample string 3</ParentName>
  <Path>sample string 10</Path>
  <Permissions>
    <InvestorDocumentPermissionModel>
      <AdvisorId>1</AdvisorId>
      <AdvisorName>sample string 2</AdvisorName>
      <AllowedToSee>true</AllowedToSee>
      <CanEdit>true</CanEdit>
    </InvestorDocumentPermissionModel>
    <InvestorDocumentPermissionModel>
      <AdvisorId>1</AdvisorId>
      <AdvisorName>sample string 2</AdvisorName>
      <AllowedToSee>true</AllowedToSee>
      <CanEdit>true</CanEdit>
    </InvestorDocumentPermissionModel>
  </Permissions>
  <SortOrder>1</SortOrder>
  <UploadDate>2025-01-02T15:39:30.096861-06:00</UploadDate>
  <VaultFileId>1</VaultFileId>
</InvestorDocumentModel>