Docs · vipvap

1. Sign up and grab your API key

Open the sign-up page, create an account, and the dashboard shows your first API key — a one-time reveal.

2. Send your first OTP

Hit POST /v1/send with a Bearer key and a JSON body.

curl -X POST https://api.vipvap.com/v1/send \
  -H "Authorization: Bearer vp_live_a4f2…" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "alice@acme.com",
    "code":      "418917"
  }'

const res = await fetch("https://api.vipvap.com/v1/send", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.VIPVAP_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    recipient: "alice@acme.com",
    code:      "418917",
  }),
});
const data = await res.json();
console.log(data.id, data.status);

import os, requests

resp = requests.post(
    "https://api.vipvap.com/v1/send",
    headers={"Authorization": f"Bearer {os.environ['VIPVAP_KEY']}"},
    json={
        "recipient": "alice@acme.com",
        "code":      "418917",
    },
    timeout=5,
)
resp.raise_for_status()
data = resp.json()

<?
$ch = curl_init("https://api.vipvap.com/v1/send");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer " . getenv("VIPVAP_KEY"),
  "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  "recipient" => "alice@acme.com",
  "code"      => "418917",
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
?>

Response

// 200 OK
{
  "id":      "snd_3f2a9b",
  "status":  "delivered",
  "to":      "alice@acme.com",
  "from":    "Acme <notify@vipvap.com>",
  "subject": "Acme: your verification code",
  "expires_in_minutes": 10,
  "quota_remaining":    1949
}

API reference

POST

/v1/send

Send one OTP email. Authenticated by Bearer key.

GET

/v1/usage

Current period usage and quota remaining.

POST /v1/send

Request body

Field	Type	Required	Description
recipient	string	required	Recipient email address.
code	string	required	The OTP. 4–12 chars; whatever your flow expects.
brand_name	string	optional	Override the per-account brand name for this single send.

Response — 200

Field	Type	Description
id	string	Send ID, used by the dashboard logs.
status	string	`delivered`, `queued`, `bounced`, `failed`.
to	string	Recipient address.
from	string	Rendered From line with brand display name.
subject	string	Rendered subject line.
expires_in_minutes	integer	Default expiry applied from your dashboard branding.
quota_remaining	integer	Hard cap minus used, after this send.

Errors

Status	code	What it means
401	invalid_api_key	Missing or wrong Bearer token.
400	invalid_recipient	Address is malformed.
400	invalid_code	Code is missing or wrong shape.
429	quota_exceeded	Hard cap reached. No overages — upgrade in the dashboard to lift it.

Webhooks

Set a webhook URL in the dashboard's Settings page and we'll POST delivery status callbacks as a single vipvap-delivery event.

{
  "event": "vipvap.delivery",
  "data": {
    "id":         "snd_3f2a9b",
    "status":     "delivered",
    "recipient":  "alice@acme.com"
  }
}

Contact

Need a higher quota, a separate sending segment, or a custom agreement? Email hi@vipvap.com.

Legal

vipvap Inc. Terms of Service and Privacy Policy apply. vipvap transmits only OTP emails. Sending other content types (marketing, transactional, anything non-OTP) is a violation of the terms and grounds for account suspension.

The quickstart.