List documents

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.

get/api/v2/documents

Request

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

Query parameters

idsstring

Filter documents by IDs (comma-separated)

identity_idinteger

Filter documents by identity ID from identities_index, identities_create

Filter documents by approval status

upload_date_fromstring date

Filter documents created from this date

upload_date_tostring date

Filter documents created until this date

order_bystring

Field to sort by

order'asc' | 'desc'

Sort order

pageinteger

Page number for pagination (starts from 1)

per_pageinteger

Number of items per page

Response

returns documents from specified identity

Example response

{
  "documents": [
    {
      "name": "Document 1",
      "id": 164,
      "user_id": 915,
      "country": "United Kingdom",
      "created_at": "2026-10-14T16:39:29Z",
      "expired_at": "2027-10-14T16:39:29Z",
      "approvement_status": "verified",
      "doc_type": "Personal ID",
      "identity_id": 163,
      "identity": {
        "id": 163,
        "name": "Paper Box 1",
        "user_id": 915,
        "created_at": "2026-10-14T16:39:29Z",
        "persistence_status": "active"
      },
      "files": [
        {
          "role": "frontside",
          "label": "File",
          "url": "/api/v2/documents/164/files/frontside",
          "name": "test.png"
        }
      ]
    }
  ],
  "pagination": {
    "total": 2,
    "total_pages": 1,
    "current_page": 1,
    "per_page": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.