APG PayAPG Paydocs

Identity

List contact verifications

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

Read the verification state of a phone number, an email address, or both. At least one is required: the platform looks a record up by its key and cannot page them all.

Permissions

Required permission
merchantCustomers:query

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

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

columnsarray of CvrfColumn

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

phoneNumberstring

E.164 format, e.g. +61400000000. At least one of phoneNumber and emailAddress is required.

emailAddressstring

At least one of phoneNumber and emailAddress is required.

Responses

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

Discriminated by type
type = "CvrfPageAttributes"
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": "CvrfPageAttributes",
  "data": [
    {
      "type": "CvrfViewAttributes",
      "subject": {
        "type": "CvrfSubjectEmail",
        "emailAddress": "ada@example.com"
      },
      "state": {
        "type": "CvrfStateAttributes",
        "verified": true,
        "expired": true,
        "failedAttempts": 1250,
        "lastFailedAt": "2026-08-19T04:21:07Z",
        "codeGeneratedAt": "2026-08-19T04:21:07Z",
        "outstandingCode": "string",
        "createdAt": "2026-08-19T04:21:07Z",
        "updatedAt": "2026-08-19T04:21:07Z"
      }
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses