v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Files

List files

Used to fetch a paginated list of files under your account

get/files

Query parameters

category'Evidence' | 'VerificationDocument' | 'Report'

Example:Evidence

Filter for files in a specific category.

ascendingboolean

Control the order (newest or oldest) in which the files are returned. false will arrange the results with newest first, whereas true shows oldest first. The default is false.

limitinteger

Example:10

Control how many items are return in a given page The max limit we allow is 25. The default is 10.

startsAfterstring

Example:fl_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

Response

Successfully retrieved the files

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

Example response

{
  "items": [
    {
      "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "name": "receipt_2024.png",
      "type": "Pdf",
      "category": "Evidence",
      "metadata": {
        "customerId": "1",
        "registered": "123"
      },
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538,
      "sizeInBytes": 2048
    }
  ],
  "paginationToken": "fl_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}