APG PayAPG Paydocs

Merchants

Get file

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

Read one document's details. The merchant is named by merchantId or the Merchant-Id header, the platform resolves a file within its merchant. Not the bytes.

Permissions

Required permission
merchantKyb:query

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

Path parameters

fileIdstring
required

Query parameters

merchantIdstring

Whose file this is. Omit it when the Merchant-Id header names the merchant.

Responses

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

Discriminated by type
type = "LfileViewAttributes"
fileIdLfileIdrequired

Identifier of a stored file.

Example lfile_9f2Kd8QpLzXw

merchantIdMchtIdrequired

The merchant the file belongs to. Every file has one.

Example mcht_9f2Kd8QpLzXw

categoryLfileCategoryrequired

Why the platform holds it. One value today, and it is the reason this collection is KYB-authorised.

MerchantOnboardingUnknown
documentTypeLfileDocumentTyperequired

What the document is. This decides which file types the platform will accept.

CompanyVerificationDocumentFrontCompanyVerificationDocumentBackCompanyTaxIdVerificationDocumentPersonVerificationDocumentFrontPersonVerificationDocumentBackPersonVerificationAdditionalDocumentFrontPersonVerificationAdditionalDocumentBackPartnershipAgreementTrustDeedTrustDeedAmendment
+1 more

Unknown

fileNamestringrequired

Example Ada Lovelace

fileTypeLfileTyperequired

The file's type, derived from its extension and validated against the document type.

PdfPngJpgJpegUnknown
sizeKbinteger (int64)required

Size in kilobytes. The platform reports kilobytes and megabytes; the finer figure is published.

Example 1250

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses