Skip to main content
GET
/
documents
List documents
curl --request GET \
  --url https://api.synctera.com/v2/documents
{
  "documents": [
    {
      "available_versions": [
        123
      ],
      "available_versions_info": [
        {
          "creation_time": "2010-05-06T12:23:34.321Z",
          "file_name": "<string>",
          "last_updated_time": "2010-05-06T12:23:34.321Z",
          "version": 123
        }
      ],
      "batch_id": "<string>",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "deletion_reason": "<string>",
      "description": "<string>",
      "encryption": "REQUIRED",
      "file_name": "<string>",
      "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "metadata": {},
      "name": "<string>",
      "related_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related_resource_type": "ACCOUNT",
      "tenant": "abcdef_ghijkl",
      "type": "ADDRESS_VERIFICATION",
      "version": 123
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
id
string<uuid>[]

Unique resource identifier

​
limit
integer
default:100

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

Required range: x >= 1
Example:

100

​
page_token
string

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

Example:

"a8937a0d"

​
related_resource_type
enum<string>

Return documents that are related to resources of the specified type

Available options:
ACCOUNT,
BUSINESS,
CUSTOMER,
EDD,
INVOICE,
REVENUE_STATEMENT
​
related_resource_id
string<uuid>

Return documents that are related to resources with the specified ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
encryption
enum<string>

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

Available options:
REQUIRED,
NOT_REQUIRED
​
type
enum<string>[]

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

​
batch_id
string

Return documents that are related to batch with the specified ID

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

Response

List documents.

​
documents
object[]
required

Array of documents

​
next_page_token
string

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

Example:

"a8937a0d"