APG PayAPG Paydocs

Identity

Update contact verifications

PATCH/contact-verifications

Reset the verification held against one contact detail: clears the failed attempts and issues a new code.

2 actionsCvrfUpdateResetEmailCvrfUpdateResetPhone

Permissions

Required permission
merchantCustomers:update

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

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "CvrfUpdateResetEmail"
emailAddressstringrequired

Example ada@example.com

curl -X PATCH https://api.tst.au.apgpay.dev/contact-verifications \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "CvrfUpdateResetEmail",
  "emailAddress": "ada@example.com"
}'

Responses

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

Discriminated by type
type = "CvrfUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "CvrfUpdateRspAttributes",
  "updated": {
    "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"
    }
  }
}

Error responses