Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Documents

List documents

Returns a paginated list of documents (metadata only, not contents).

get/documents

Query parameters

related_resource_idstring uuid
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

Return documents that are related to resources with the specified ID

batch_idstring
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

Return documents that are related to batch with the specified ID

typeDocumentType[]

The type of documents. Multiple types can be provided as a comma-separated list.

encryption'NOT_REQUIRED' | 'REQUIRED'

Whether the file should be encrypted and access restricted, e.g. if the file contains PII

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
idstring[]

Unique resource identifier

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
related_resource_type'ACCOUNT' | 'BUSINESS' | 'CUSTOMER' | 'EDD' | 'INVOICE' | 'REVENUE_STATEMENT'

The type of the resource related to the document

Return documents that are related to resources of the specified type

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List documents.

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "next_page_token": "a8937a0d",
  "documents": [
    {
      "available_versions_info": [
        {
          "creation_time": "2010-05-06T12:23:34.321Z",
          "last_updated_time": "2010-05-06T12:23:34.321Z"
        }
      ],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "tenant": "abcdef_ghijkl"
    }
  ]
}