APG PayAPG Paydocs

Merchants

List files

GET/files
Request
GEThttps://api.tst.au.apgpay.dev/files
curl -X GET https://api.tst.au.apgpay.dev/files \
  -H "Authorization: Bearer $API_KEY"

Return a merchant's KYB documents. The merchant is named by merchantId or the Merchant-Id header, and the whole set comes back in one page, there are never many. GET /filter-catalogues/files lists the filters this caller can use. A cursor continues only the walk that issued it: sent with a different merchantId, filters, q or sort, it is refused with 400.

Permissions

Required permission
merchantKyb:query

Requires the `query` action on `merchantKyb` for the supplied runtime context

Query parameters

qstring

Search. Matches a file id or the file name. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

columnsarray of LfileColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

merchantIdstring

Whose files to read. Omit it when the Merchant-Id header names the merchant.

categoryone of LfileCategory, array of LfileCategory

Only files whose category is one of these. Repeat the parameter to give several.

documentTypeone of LfileDocumentType, array of LfileDocumentType

Only files whose kind of document is one of these. Repeat the parameter to give several.

Responses

The response is a tagged shape: type is always "LfilePageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "LfilePageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "LfilePageAttributes",
  "data": [
    {
      "type": "LfileViewAttributes",
      "fileId": "lfile_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "category": "MerchantOnboarding",
      "documentType": "CompanyVerificationDocumentFront",
      "fileName": "Ada Lovelace",
      "fileType": "Pdf",
      "sizeKb": 1250,
      "createdAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses