List Documents

Retrieve a list of your documents, with options to filter by status and paginate the results.

Endpoint: GET /api/proof/document
Description: This endpoint fetches a batch of documents based on their status. You can filter documents by their processing status and paginate through the results.

Headers

x-access-token (string, required): Your API token.

Query Parameters

status (string, required): Filter documents by status. Possible values:
- confirmed
- pending
- pending_stamp
page (number, required): The page number to retrieve (starting from 0).
limit (number, required): The number of results per page.

Response

200 OK

The request was successful, and a list of documents is returned.
```
{
  "ok": true,
  "data": {
    "totalPages": 1,
    "totalCount": 1,
    "documents": [
      {
        "id": 5198978,
        "name": "source-simpleproof.png",
        "extension": "png",
        "storage_kb": "6.1",
        "creation_date": "2024-03-27T18:29:17.684Z",
        "document_hash": "870c8bcd4278ddfc1f8bd5769190b5513f05bed50f32b52f711ffbdf4f544d45",
        "prefix": "lnvtest/simpleproof-kpaowlua53vp1/",
        "blockchain": 910775,
        "document_status": "COMPLETE"
      }
    ]
  }
}
```
Response Fields
- ok (boolean): Indicates if the request was successful
- data (object): Contains the response data with the following fields:
  - totalPages (integer): Total number of pages available for the current filter
  - totalCount (integer): Total number of documents matching the filter criteria
  - documents (array): Array of document objects with the following fields:
    - id (integer): Unique internal document identifier
    - name (string): Original filename of the document
    - extension (string): File extension (e.g., "png", "pdf", "csv")
    - storage_kb (string): Document size in kilobytes
    - creation_date (string): ISO 8601 timestamp when the document was uploaded
    - document_hash (string): SHA-256 hash of the document
    - prefix (string): Internal storage path prefix
    - blockchain (integer): Bitcoin block number where the document was confirmed (null for unconfirmed documents)
    - document_status (string): Current processing status of the document
400 Bad Request

The request was invalid or cannot be otherwise served.
```
{
  "ok": false,
  "msg": "Something went wrong."
}
```

Getting More Document Details

For complete document information including verification URLs, download links, and confirmation details, use the Verify a Document endpoint with the document_hash from this response.