APG PayAPG Paydocs

Parties

Get person

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

Return one person in the caller's scope.

Permissions

Required permission
persons:query

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

Path parameters

personIdstring
required

Responses

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

Discriminated by type
type = "PrsnViewAttributes"
personIdPsonIdrequired

Identifier of a person. A beneficial owner is a person, so it is identified by its person's identifier.

Example pson_9f2Kd8QpLzXw

givenNamestring

Example Ada Lovelace

middleNamestring

Example Ada Lovelace

familyNamestringrequired

Example Ada Lovelace

dateOfBirthstring (date)

Date of birth, ISO 8601. Absent where none is held, and from a caller without Persons view PII.

Example 2026-08-19

The passport and the driver licence held for this person, at most one of each. Absent where there are none, and from a caller without Persons view PII.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "PrsnViewAttributes",
  "personId": "pson_9f2Kd8QpLzXw",
  "givenName": "Ada Lovelace",
  "middleName": "Ada Lovelace",
  "familyName": "Ada Lovelace",
  "dateOfBirth": "2026-08-19",
  "identityDocuments": [
    {
      "type": "PsonDocumentDriverLicence",
      "number": "string",
      "issuingCountry": "AU",
      "issuingRegion": "string",
      "documentNumber": "string",
      "versionNumber": "string"
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses