---
title: "List documents"
method: GET
path: "/documents"
tags: ["Documents"]
---

# List documents

`GET /documents`

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

## Query parameters

- `related_resource_id` string, uuid
- `batch_id` string
- `type` DocumentType[]
- `encryption` 'NOT_REQUIRED' | 'REQUIRED'
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `id` string[]
- `related_resource_type` 'ACCOUNT' | 'BUSINESS' | 'CUSTOMER' | 'EDD' | 'INVOICE' | 'REVENUE_STATEMENT' — The type of the resource related to the document
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

## Response `200`

List documents.

- DocumentList
  - `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.
  - `documents` DocumentResponse[], required — Array of documents
    - `available_versions` integer[] — All document versions
    - `available_versions_info` DocumentVersionInfo[] — Metadata of all document versions
      - `creation_time` string, date-time — The date and time the resource was created
      - `file_name` string — The file name of the document
      - `last_updated_time` string, date-time — The date and time the resource was last updated
      - `version` integer — Positive integer representing the version of the document
    - `batch_id` string — The ID of the batch that the document belongs to
    - `creation_time` string, date-time — The date and time the resource was created
    - `deletion_reason` string — An explanation why the file was deleted. You must set a document's deletion_reason before deleting it.
    - `description` string — A description of the document
    - `encryption` 'NOT_REQUIRED' | 'REQUIRED' — Whether the file will be encrypted by the Synctera platform before storing. All documents containing PII must be encrypted. Creating and retrieving encrypted documents requires documents_encrypted:write and documents_encrypted:read permissions, respectively. If encryption is not specified, a default will be chosen based on the document type. See the following table. Document types with a default of REQUIRED must be encrypted. It is an error to explicitly set encryption to NOT_REQUIRED for these document types. Document types with a default of NOT_REQUIRED may optionally be encrypted by explicitly setting encryption to REQUIRED. | Document Type | Default Encryption | |---------------|---------------------| | ADDRESS_VERIFICATION | REQUIRED | | APPLICATION_DOCUMENTATION | NOT_REQUIRED | | BILLING_DOCUMENT | NOT_REQUIRED | | CHECK_IMAGE | REQUIRED | | COMPANY_PROFILE_DOCUMENT | NOT_REQUIRED | | COMPLIANCE_REPORT | REQUIRED | | DATE_OF_BIRTH_VERIFICATION | REQUIRED | | FINANCIAL_FILE | REQUIRED | | IDENTITY_DOCUMENTATION | REQUIRED | | INCOME_DOCUMENTATION | REQUIRED | | STATEMENT | NOT_REQUIRED | | STATEMENT_DISCLOSURE | NOT_REQUIRED | | TAX_FORM | REQUIRED | | TERMS_OF_SERVICE | NOT_REQUIRED |
    - `file_name` string — The file name of the document
    - `id` string, uuid — The unique identifier for this resource
    - `last_updated_time` string, date-time — The date and time the resource was last updated
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `name` string — A user-friendly name for the document
    - `related_resource_id` string, uuid — The ID of the resource related to the document
    - `related_resource_type` 'ACCOUNT' | 'BUSINESS' | 'CUSTOMER' | 'EDD' | 'INVOICE' | 'REVENUE_STATEMENT' — The type of the resource related to the document
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `type` 'ADDRESS_VERIFICATION' | 'APPLICATION_DOCUMENTATION' | 'BILLING_DOCUMENT' | 'CHECK_IMAGE' | 'COMPANY_PROFILE_DOCUMENT' | 'COMPLIANCE_REPORT' | 'DATE_OF_BIRTH_VERIFICATION' | 'FINANCIAL_FILE' | 'IDENTITY_DOCUMENTATION' | 'INCOME_DOCUMENTATION' | 'STATEMENT' | 'STATEMENT_DISCLOSURE' | 'TAX_FORM' | 'TERMS_OF_SERVICE' — The type of the document. The type can be changed after the document is created, except that a non-encrypted document cannot be changed to a type that requires encryption.
    - `version` integer — Positive integer representing the version of the document

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `404` — Resource not found
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)