POST /v2/verifications/:id/purge
{
"id": "9d2e4b8c1a7f53e06c4b9d2a8e1f0c57",
"name": "Ted Annature",
"email": "ted@annature.com.au",
"mobile": "+61422000000",
"mobile_otp": "+61422000000",
"message": "Lorem ipsum dolor sit amet.",
"message_sms": "Lorem ipsum dolor sit amet: {{token}}",
"status": "completed",
"account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
"group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
"shared": false,
"warning": null,
"muted": false,
"screening": false,
"biometrics": false,
"created": "2026-08-24T00:00:00Z",
"cancelled": null,
"completed": "2026-08-24T00:00:00Z",
"purging": null,
"purged": "2026-08-24T00:00:00Z",
"metadata": {}
}
Verifications
Purge a verification
POST /v2/verifications/:id/purge
{
"id": "9d2e4b8c1a7f53e06c4b9d2a8e1f0c57",
"name": "Ted Annature",
"email": "ted@annature.com.au",
"mobile": "+61422000000",
"mobile_otp": "+61422000000",
"message": "Lorem ipsum dolor sit amet.",
"message_sms": "Lorem ipsum dolor sit amet: {{token}}",
"status": "completed",
"account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
"group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
"shared": false,
"warning": null,
"muted": false,
"screening": false,
"biometrics": false,
"created": "2026-08-24T00:00:00Z",
"cancelled": null,
"completed": "2026-08-24T00:00:00Z",
"purging": null,
"purged": "2026-08-24T00:00:00Z",
"metadata": {}
}
Verification endpoints use the
/v2/ namespace. /v1/ endpoints are deprecated and will be removed without notice to new integrators.completed. Verifications that have already been purged cannot be purged again.
After a successful purge, the verification’s purged timestamp will be set. The verification record itself is retained.
Parameters
string
The unique identifier of the verification to purge.
POST /v2/verifications/:id/purge
{
"id": "9d2e4b8c1a7f53e06c4b9d2a8e1f0c57",
"name": "Ted Annature",
"email": "ted@annature.com.au",
"mobile": "+61422000000",
"mobile_otp": "+61422000000",
"message": "Lorem ipsum dolor sit amet.",
"message_sms": "Lorem ipsum dolor sit amet: {{token}}",
"status": "completed",
"account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
"group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
"shared": false,
"warning": null,
"muted": false,
"screening": false,
"biometrics": false,
"created": "2026-08-24T00:00:00Z",
"cancelled": null,
"completed": "2026-08-24T00:00:00Z",
"purging": null,
"purged": "2026-08-24T00:00:00Z",
"metadata": {}
}