APG PayAPG Paydocs

Merchants

List beneficial owners

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

Return a merchant's beneficial owners. The merchant is named by merchantId or the Merchant-Id header, and the whole set comes back in one page.

Permissions

Required permission
merchantKyb:query

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

Query parameters

qstring

Search. Matches a beneficial owner id, the first or last name, or the whole email address. 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 PsonColumn

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 owners to read. Omit it when the Merchant-Id header names the merchant.

verificationStatusone of PsonVerificationStatus, array of PsonVerificationStatus

Filter by verification status. Repeat the parameter to supply several.

Responses

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

Discriminated by type
type = "PsonPageAttributes"
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": "PsonPageAttributes",
  "data": [
    {
      "type": "PsonViewAttributes",
      "beneficialOwnerId": "pson_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "profile": {
        "type": "PsonProfileAttributes",
        "title": "string",
        "roles": [
          "Director"
        ],
        "givenName": "Ada Lovelace",
        "middleName": "Ada Lovelace",
        "familyName": "Ada Lovelace",
        "dateOfBirth": "2026-08-19",
        "address": {
          "type": "PsonAddressAttributes",
          "unitNumber": "string",
          "streetNumber": "string",
          "streetName": "Ada Lovelace",
          "streetType": "string",
          "suburb": "string",
          "city": "string",
          "state": "string",
          "postalCode": "3000",
          "country": "AU"
        },
        "emailAddress": "ada@example.com",
        "phoneNumber": "+61400000000",
        "identityDocuments": [
          {
            "type": "PsonDocumentDriverLicence",
            "number": "string",
            "issuingCountry": "AU",
            "issuingRegion": "string",
            "documentNumber": "string",
            "versionNumber": "string"
          }
        ],
        "verificationDocument": {
          "type": "PsonVerificationDocAttributes",
          "idType": "Passport",
          "frontFileId": "lfile_9f2Kd8QpLzXw",
          "backFileId": "lfile_9f2Kd8QpLzXw"
        }
      },
      "verification": {
        "type": "PsonVerificationAttributes",
        "status": "Pending",
        "errorCodes": [
          "string"
        ],
        "details": [
          "string"
        ]
      },
      "deletable": true
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses