Cancel Verification
Cancel a verification that is still pending or sent.
Cancel a verification that is still pending or sent.
Scope: verify.verifications.write
Path Parameters
idstringrequiredVerification ID with the vrf_ prefix.
Sample Request
Request
curl -X POST "https://api.maileroo.com/v1/verify/verifications/vrf_0123456789abcdef01234567/cancel" \
-H "Authorization: Bearer roo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Sample Response
Returns 200 OK with the cancelled verification.
Response
{
"data": {
"id": "vrf_0123456789abcdef01234567",
"account_id": "12345",
"sender_profile_id": "prf_0123456789abcdef01234567",
"channel": "sms",
"to": "+61412345678",
"country": "AU",
"code_length": 6,
"status": "cancelled",
"attempts": 0,
"max_attempts": 3,
"expires_at": "2025-01-01T12:15:00Z",
"created_at": "2025-01-01T12:00:00Z",
"updated_at": "2025-01-01T12:01:00Z"
}
}The max_attempts value is illustrative; the response reports the applicable value.
Errors
Common authentication, rate-limit, and service-availability errors are described in the Introduction. This endpoint can also return:
404 Not Found— the verification does not exist for this account.409 Conflict— the verification is already terminal and cannot be cancelled.