Cancel a verification

Cancels a verification. A cancelled verification can no longer be checked.

POST

https://app.touchsms.com.au/api/v3/verify/{verify}/cancel

Authorization

basicAuth
HTTP
required

Path parameters

verify
string
required
Verification ID returned when it was created.

format: uuid

Returns

200

The cancelled verification.

JSON

data
optional
object
- id
  optional
  string
  format: uuid
- status
  optional
  created
  or
  sent
  or
  expired
  or
  failed
  or
  verified
  or
  cancelled
- type
  optional
  sms
  or
  email
- destination
  optional
  string
- source
  optional
  string
- metadata
  optional
  object | null
- template
  optional
  string
- expires_at
  optional
  string
  format: date-time
- created_at
  optional
  string
  format: date-time
}

400

The verification has already been verified.

JSON

message
string
required

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

{ "data": { "id": "cb4d9527-1d3a-4def-85ba-f1fec9489c4f", "status": "sent", "type": "sms", "destination": "+61412345678", "source": "SHARED_NUMBER", "metadata": { "action": "login" }, "template": "Your verification code is %code%", "expires_at": "2024-03-11T02:19:07.000000Z", "created_at": "2024-03-11T02:14:07.000000Z" } }