POST api/SecureArchive/GetDocumentsByAccount

Get documents from SecureArchive corresponding to the provided clientId and account number

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId	The UserId making the request. Value is a SouthData client number	string	None.
AuthToken	The AuthToken required to validate the request. Must be unique for each and every request. See documentation on how to generate an auth token	string	None.
ClientId	ClientId to pull documents for	integer	None.
AccountNumber	Account number to pull document for	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "sample string 1",
  "AuthToken": "sample string 2",
  "ClientId": 3,
  "AccountNumber": "sample string 4"
}

application/xml, text/xml

Sample:

<GetDocumentsByAccountRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AccountNumber>sample string 4</AccountNumber>
  <AuthToken>sample string 2</AuthToken>
  <ClientId>3</ClientId>
  <UserId>sample string 1</UserId>
</GetDocumentsByAccountRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing document details for the provided clientId and account number

SecureArchiveDocumentResponseModel

Name	Description	Type	Additional information
DocumentID	DocumentID which can be used with GetDocument to retrieve actual document bytes	integer	None.
OrderID	OrderId that the document was a part of	integer	None.
SDI	SDI product identifier for the document	string	None.
StatementDate	Date printed on statement when applicable	date	None.
ShippedDate	Date document was shipped	date	None.
Amount	Amount due on the statement when applicable	decimal number	None.
CertMailTrackingNo	Certified mail tracking number when applicable	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentID": 1,
  "OrderID": 1,
  "SDI": "sample string 2",
  "StatementDate": "2026-02-11T04:08:10.2299522-05:00",
  "ShippedDate": "2026-02-11T04:08:10.2299522-05:00",
  "Amount": 1.0,
  "CertMailTrackingNo": "sample string 3"
}

application/xml, text/xml

Sample:

<SecureArchiveDocumentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <Amount>1</Amount>
  <CertMailTrackingNo>sample string 3</CertMailTrackingNo>
  <DocumentID>1</DocumentID>
  <OrderID>1</OrderID>
  <SDI>sample string 2</SDI>
  <ShippedDate>2026-02-11T04:08:10.2299522-05:00</ShippedDate>
  <StatementDate>2026-02-11T04:08:10.2299522-05:00</StatementDate>
</SecureArchiveDocumentResponseModel>