APG PayAPG Paydocs

Customers

Get customer

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

Return one customer.

Permissions

Required permission
merchantCustomers:query

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

Path parameters

customerIdstring
required

Responses

The response is a typed union.

Discriminated by type
type = "CustViewConsumer"
customerIdCustIdrequired

Identifier of a customer.

Example cust_9f2Kd8QpLzXw

personIdPsonIdrequired

The person this customer is, read at GET /persons/{personId}.

Example pson_9f2Kd8QpLzXw

merchantIdstringrequired

Example mcht_9f2Kd8QpLzXw

marketplaceIdstring

The marketplace the merchant sits under, where there is one.

Example mktp_9f2Kd8QpLzXw

referenceCustomerIdstring

Example your-own-reference

givenNamestring

Example Ada Lovelace

middleNamestring

Example Ada Lovelace

familyNamestring

Absent when the caller may not see personal data, see the note on this view.

Example Ada Lovelace

emailAddressstring

Absent when the caller may not see personal data.

Example ada@example.com

phoneNumberstring

Example +61400000000

isVerifiedbooleanrequired

Whether the customer's contact details have been verified.

Example true

Identity checks attempted against this customer, by the evidence they were run with.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "CustViewConsumer",
  "customerId": "cust_9f2Kd8QpLzXw",
  "personId": "pson_9f2Kd8QpLzXw",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "marketplaceId": "mktp_9f2Kd8QpLzXw",
  "referenceCustomerId": "your-own-reference",
  "givenName": "Ada Lovelace",
  "middleName": "Ada Lovelace",
  "familyName": "Ada Lovelace",
  "emailAddress": "ada@example.com",
  "phoneNumber": "+61400000000",
  "isVerified": true,
  "kycAttempts": {
    "type": "CustKycAttemptsAttributes",
    "withoutDocument": 1250,
    "withDriversLicence": 1250,
    "withPassport": 1250,
    "withDriversLicenceAndPassport": 1250,
    "level": "string"
  },
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses