Skip to main content

​
Verify API

Send one-time verification codes to users and validate them. Supports delivery via SMS, WhatsApp, and Email. Built-in rate limiting, expiration, and attempt tracking. Base path: /v1/verify

​
Send Verification

POST /v1/verify/send Generate a verification code and deliver it to the recipient on the specified channel.
​
to
string
required
Recipient phone number (E.164) or email address
​
channel
string
required
Delivery channel: sms, whatsapp, email
​
max_attempts
integer
default:"3"
Maximum number of check attempts before the code is invalidated
curl -X POST https://orbit-api.devotel.io/api/v1/verify/send \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155552671",
    "channel": "sms",
    "max_attempts": 3
  }'

{
  "data": {
    "verification_id": "vrf_abc123",
    "to": "+14155552671",
    "channel": "sms",
    "status": "pending",
    "max_attempts": 3,
    "expires_at": "2026-03-08T12:10:00Z",
    "created_at": "2026-03-08T12:00:00Z"
  },
  "meta": {
    "request_id": "req_vrf_001",
    "timestamp": "2026-03-08T12:00:00Z"
  }
}

​
Check Verification

POST /v1/verify/check Validate a verification code submitted by the user.
​
verification_id
string
required
The verification ID returned from the send endpoint
​
code
string
required
The code entered by the user
curl -X POST https://orbit-api.devotel.io/api/v1/verify/check \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "verification_id": "vrf_abc123",
    "code": "482910"
  }'

{
  "data": {
    "verification_id": "vrf_abc123",
    "status": "approved",
    "attempts_remaining": 2,
    "checked_at": "2026-03-08T12:01:30Z"
  },
  "meta": {
    "request_id": "req_chk_001",
    "timestamp": "2026-03-08T12:01:30Z"
  }
}

​
Possible Check Statuses

StatusDescription
approvedCode is correct — verification passed
rejectedCode is incorrect — attempts remaining
expiredVerification has expired (default 10 minutes)
maxedMaximum check attempts reached — code is invalidated

​
List Verifications

GET /v1/verify Retrieve verification records with optional filtering and cursor-based pagination.
​
cursor
string
Cursor for pagination
​
limit
integer
default:"20"
Number of results per page (max 100)
​
status
string
Filter by status: pending, approved, rejected, expired, maxed
​
channel
string
Filter by delivery channel: sms, whatsapp, email
curl "https://orbit-api.devotel.io/api/v1/verify?status=approved&channel=sms&limit=10" \
  -H "X-API-Key: dv_live_sk_your_key_here"

{
  "data": [
    {
      "verification_id": "vrf_abc123",
      "to": "+14155552671",
      "channel": "sms",
      "status": "approved",
      "created_at": "2026-03-08T12:00:00Z",
      "checked_at": "2026-03-08T12:01:30Z"
    }
  ],
  "meta": {
    "request_id": "req_vrf_list",
    "timestamp": "2026-03-08T12:05:00Z",
    "pagination": {
      "cursor": "cur_vrf_abc",
      "has_more": false
    }
  }
}