Verifications

Cancel a pending verification

Cancels a verification that has not yet received a code. The number is released and the wallet is refunded atomically in the same database transaction.

Cancellation is only valid while can_cancel: true on the verification. Once a code arrives the call returns 409 CANCEL_NOT_ALLOWED.

post/verifications/{id}/cancel

Request

  • Base URL: https://dashboard.voidmob.com/api/v1
  • URL: https://dashboard.voidmob.com/api/v1/verifications/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Opaque verification (SMS rental) identifier.

Example:ver_01HXYZ123ABC

Headers

Idempotency-Keystring required
Example:7c4f08c2-2a4f-4c8e-a1d2-9c2b9c8f7e10

Client-supplied key (any string, up to 255 chars) that scopes idempotent replay for write requests. Required on every POST, PATCH, and DELETE. Replays with the same key + same body return the cached response; same key with a different body returns IDEMPOTENCY_CONFLICT. Headers are case-insensitive; both Idempotency-Key and idempotency-key work.

Response

Verification cancelled; refunded amount included.

successtrue required

Example response

{
  "data": {
    "verification": {
      "id": "ver_01HXYZ123ABC"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.