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

# List documents

`GET /api/v2/documents`

## Request

- Base URL: `https://app.didlogic.com`
- URL: `https://app.didlogic.com/api/v2/documents`
- Auth: HTTP bearer

Retrieve a list of documents with filtering and pagination.

**Important notes:**
- Supports filtering by approval status, identity ID, and date range
- Results can be sorted and paginated

`documents[].id` feeds documents_show, documents_update, documents_destroy and documents_files_download_file;
`documents[].files[].role` feeds documents_files_download_file; `documents[].identity_id` feeds
identities_index. Full record: documents_show.

## Query parameters

- `ids` string
- `identity_id` integer
- `approvement_status` 'pending' | 'approved' | 'rejected' | 'expired' | 'in review' | 'verified'
- `upload_date_from` string, date
- `upload_date_to` string, date
- `order_by` string
- `order` 'asc' | 'desc'
- `page` integer
- `per_page` integer

## Response `200`

returns documents from specified identity

- object
  - `documents` object[], required: List of documents
    - `name` string, required: Document name
    - `id` integer, required: Document identifier
    - `user_id` integer, required: Owner user ID
    - `country` string, required: Country of the document, as given at upload; for a letter of intent, the country of the purchased number
    - `created_at` string, required: Upload timestamp
    - `expired_at` string, required: Document expiration timestamp
    - `approvement_status` 'in review' | 'verified' | 'rejected' | 'expired', required: Document approval status (in review = pending, verified = approved)
    - `doc_type` 'Personal ID' | 'Proof of address' | 'Business Registration' | 'Letter of Intent', required: Document type identifier
    - `identity_id` integer, required: Associated identity ID
    - `identity` object, required: Identity details
      - `id` integer, required: Identity identifier
      - `name` string, required: Identity name
      - `user_id` integer, required: Owner user ID
      - `created_at` string, required: Identity creation timestamp
      - `persistence_status` 'active' | 'archived' | 'active-immortal', required: Identity persistence status
      - `is_default` boolean, required: Is default identity flag
    - `files` object[], required: Document files
      - `role` string, required: File role (frontside, backside)
      - `label` string, required: File label
      - `url` string, required: File download URL
      - `name` string, required: Original file name
  - `pagination` object, required: Pagination metadata
    - `total` integer, required: Total number of items
    - `total_pages` integer, required: Total number of pages
    - `current_page` integer, required: Current page number
    - `per_page` integer, required: Items per page

## Other responses

- `401`: returns unauthorized

---

[API](https://skmtc.dev/didlogic/apis/get-started.md) · [All operations](https://skmtc.dev/didlogic/apis/get-started/llms.txt) · [OpenAPI document](https://skmtc.dev/didlogic/apis/get-started/revisions/dc972d592b34?raw)